> ## Documentation Index > Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt > Use this file to discover all available pages before exploring further. # Upwork job API > Get an Upwork job's details. Call the Upwork job API and get JSON back in one request. 1 credit per call. Failed calls cost nothing. Returns an Upwork job's details. The job is identified by its URL or ID. ## Request Exactly one of `jobUrl` or `jobId` is required. A request that sets both, or none, fails with `invalidRequest`. ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null} import { Stophy } from "stophy"; const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY }); const result = await stophy.upwork.job({ jobUrl: "https://www.upwork.com/jobs/~021234567890123456789" }); console.log(result.data); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.upwork.job(job_url="https://www.upwork.com/jobs/~021234567890123456789") print(result["data"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/upwork/job \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"jobUrl":"https://www.upwork.com/jobs/~021234567890123456789"}' ``` ```bash CLI icon="square-terminal" theme={null} stophy upwork job --jobUrl "https://www.upwork.com/jobs/~021234567890123456789" ``` ## Response If successful, the response body contains the standard envelope. `data` contains the job's description, budget and skills, and what the job page shows about the client. The following example is illustrative. ```json theme={null} { "success": true, "data": { "jobId": "~021234567890123456789", "jobUrl": "https://www.upwork.com/jobs/~021234567890123456789", "title": "React developer for a dashboard", "description": "We need a React developer to build a reporting dashboard.", "skills": ["React", "TypeScript"], "type": "hourly", "experienceLevel": "intermediate", "workload": "partTime", "duration": "oneToThreeMonths", "hourlyRateMin": 30, "hourlyRateMax": 60, "publishedAt": "2026-10-05T09:30:00.000Z", "applicants": 12, "hired": 0, "interviewing": 2, "invitesSent": 3, "positions": 1, "clientCountry": "United States", "clientTotalSpent": 18000, "clientHires": 24, "clientReviews": 18, "clientRating": 4.9 }, "creditsUsed": 1, "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b" } ``` | Field | Type | Description | | - | - | - | | `type` | string | Indicates whether the job pays by the hour (`hourly`) or a fixed price (`fixed`). | | `workload` | string | Upwork's hours needed. Empty when the job does not say, including fixed-price jobs and clients who are not sure. | | `duration` | string | Upwork's project length. `underOneMonth` is under one month, `oneToThreeMonths` is one to three months, `threeToSixMonths` is three to six months, and `overSixMonths` is longer. | | `clientTotalSpent` | number | The amount the client has spent in all. | | `publishedAt` | string (ISO 8601) | The publication time, in UTC. | For every field, see the response schema on this page. ## Billing Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed. ## Pagination This method is not paginated. A single request returns the complete result. ## Related methods * [Upwork search](/api-reference/endpoint/upwork-search): Accepts the job's `title` as `query`. Searches Upwork jobs. ## OpenAPI ````yaml api-reference/openapi.json POST /v1/upwork/job openapi: 3.1.0 info: title: Stophy API version: '1' description: >- Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400. Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent. x-credits is what one call costs. Every call costs the same, whatever it returns, unless an operation's description says it costs per 10 results, or per second of audio. Then x-credits is the lowest price and x-credits-max the most one call can cost. Where an operation takes limit, send it to return fewer results and pay for fewer. When a response has a cursor, send it back unchanged with the same input to get the next page. When it has a page, send the next page number. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/upwork/job: post: summary: Get an Upwork job's details description: Costs 1 credit per call. operationId: upworkJob requestBody: required: true content: application/json: schema: type: object properties: jobUrl: type: string description: >- Link to the Upwork job, like https://www.upwork.com/jobs/~021234567890123456789. Send this or jobId. jobId: type: string description: >- Upwork job id, like ~021234567890123456789. Send this or jobUrl. sendOne: - jobUrl - jobId additionalProperties: false responses: '200': description: The data, and the credits this call used. headers: X-Request-ID: $ref: '#/components/headers/RequestId' x-credits-used: $ref: '#/components/headers/CreditsUsed' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' x-cache: $ref: '#/components/headers/Cache' x-cache-age: $ref: '#/components/headers/CacheAge' content: application/json: schema: type: object required: - success - data - creditsUsed - requestId properties: success: const: true data: type: object additionalProperties: false properties: jobId: type: string jobUrl: type: string format: uri title: type: string description: type: string skills: type: array items: type: string type: type: string enum: - hourly - fixed experienceLevel: type: string enum: - entry - intermediate - expert workload: description: >- Upwork's hours needed. Empty when the job does not say, including fixed-price jobs and clients who are not sure. type: string enum: - fullTime - partTime - asNeeded duration: description: >- Upwork's project length. underOneMonth is under one month, oneToThreeMonths is one to three months, threeToSixMonths is three to six months, and overSixMonths is longer. type: string enum: - underOneMonth - oneToThreeMonths - threeToSixMonths - overSixMonths hourlyRateMin: type: number hourlyRateMax: type: number fixedBudget: type: number budgetCurrency: type: string durationWeeks: type: integer minimum: -9007199254740991 maximum: 9007199254740991 publishedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ status: type: string category: type: string categoryGroup: type: string durationText: type: string applicants: type: integer minimum: -9007199254740991 maximum: 9007199254740991 hired: type: integer minimum: -9007199254740991 maximum: 9007199254740991 interviewing: type: integer minimum: -9007199254740991 maximum: 9007199254740991 invitesSent: type: integer minimum: -9007199254740991 maximum: 9007199254740991 unansweredInvites: type: integer minimum: -9007199254740991 maximum: 9007199254740991 positions: type: integer minimum: -9007199254740991 maximum: 9007199254740991 lastClientActivityAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ clientCity: type: string clientCountry: type: string clientTimezone: type: string clientTotalSpent: type: number clientHires: type: integer minimum: -9007199254740991 maximum: 9007199254740991 clientJobsWithHires: type: integer minimum: -9007199254740991 maximum: 9007199254740991 clientActiveContracts: type: integer minimum: -9007199254740991 maximum: 9007199254740991 clientReviews: type: integer minimum: -9007199254740991 maximum: 9007199254740991 clientRating: type: number clientOpenJobs: type: integer minimum: -9007199254740991 maximum: 9007199254740991 clientPostedJobs: type: integer minimum: -9007199254740991 maximum: 9007199254740991 clientJoinedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ clientIndustry: type: string clientCompanySize: type: string required: - jobUrl - skills creditsUsed: type: integer requestId: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: headers: RequestId: description: The request id. Quote it when you report a problem. schema: type: string CreditsUsed: description: Credits this call used. schema: type: integer RateLimitLimit: description: Requests allowed in the current window. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RateLimitReset: description: Unix time in seconds when the current window resets. schema: type: integer Cache: description: hit if this result came from the cache, miss if it was fetched live. schema: type: string CacheAge: description: Seconds since the returned result was written to the cache. schema: type: integer RetryAfter: description: Seconds to wait before retrying. schema: type: integer responses: Error: description: The request failed. retryable says whether trying again can help. headers: X-Request-ID: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - success - error properties: success: const: false error: type: object required: - code - message - retryable - requestId properties: code: type: string enum: - cliSessionCompleted - cliSessionExists - cliSessionNotFound - forbidden - insufficientCredits - internalError - inviteClaimed - inviteDisabled - inviteExpired - inviteUsedUp - invalidCliSession - invalidCliVerifier - invalidRequest - notFound - rateLimited - sourceChanged - sourceRefused - sourceTimeout - sourceUnavailable - tooManyInFlight - unauthorized - unsupportedMediaType message: type: string retryable: type: boolean retryAfterSeconds: type: integer requestId: type: string requiredCredits: type: number availableCredits: type: number billingUrl: type: string const: https://stophy.dev/billing securitySchemes: apiKey: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.