Upwork job API

Get an Upwork job's details

curl --request POST \
  --url https://api.stophy.dev/v1/upwork/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobUrl": "<string>",
  "jobId": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({jobUrl: '<string>', jobId: '<string>'})
};

fetch('https://api.stophy.dev/v1/upwork/job', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/upwork/job"

payload = {
    "jobUrl": "<string>",
    "jobId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "jobUrl": "<string>",
    "skills": [
      "<string>"
    ],
    "jobId": "<string>",
    "title": "<string>",
    "description": "<string>",
    "type": "hourly",
    "experienceLevel": "entry",
    "workload": "fullTime",
    "duration": "underOneMonth",
    "hourlyRateMin": 123,
    "hourlyRateMax": 123,
    "fixedBudget": 123,
    "budgetCurrency": "<string>",
    "durationWeeks": 0,
    "publishedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "category": "<string>",
    "categoryGroup": "<string>",
    "durationText": "<string>",
    "applicants": 0,
    "hired": 0,
    "interviewing": 0,
    "invitesSent": 0,
    "unansweredInvites": 0,
    "positions": 0,
    "lastClientActivityAt": "2023-11-07T05:31:56Z",
    "clientCity": "<string>",
    "clientCountry": "<string>",
    "clientTimezone": "<string>",
    "clientTotalSpent": 123,
    "clientHires": 0,
    "clientJobsWithHires": 0,
    "clientActiveContracts": 0,
    "clientReviews": 0,
    "clientRating": 123,
    "clientOpenJobs": 0,
    "clientPostedJobs": 0,
    "clientJoinedAt": "2023-11-07T05:31:56Z",
    "clientIndustry": "<string>",
    "clientCompanySize": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

upwork

job

Get an Upwork job's details

curl --request POST \
  --url https://api.stophy.dev/v1/upwork/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobUrl": "<string>",
  "jobId": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({jobUrl: '<string>', jobId: '<string>'})
};

fetch('https://api.stophy.dev/v1/upwork/job', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/upwork/job"

payload = {
    "jobUrl": "<string>",
    "jobId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "jobUrl": "<string>",
    "skills": [
      "<string>"
    ],
    "jobId": "<string>",
    "title": "<string>",
    "description": "<string>",
    "type": "hourly",
    "experienceLevel": "entry",
    "workload": "fullTime",
    "duration": "underOneMonth",
    "hourlyRateMin": 123,
    "hourlyRateMax": 123,
    "fixedBudget": 123,
    "budgetCurrency": "<string>",
    "durationWeeks": 0,
    "publishedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "category": "<string>",
    "categoryGroup": "<string>",
    "durationText": "<string>",
    "applicants": 0,
    "hired": 0,
    "interviewing": 0,
    "invitesSent": 0,
    "unansweredInvites": 0,
    "positions": 0,
    "lastClientActivityAt": "2023-11-07T05:31:56Z",
    "clientCity": "<string>",
    "clientCountry": "<string>",
    "clientTimezone": "<string>",
    "clientTotalSpent": 123,
    "clientHires": 0,
    "clientJobsWithHires": 0,
    "clientActiveContracts": 0,
    "clientReviews": 0,
    "clientRating": 123,
    "clientOpenJobs": 0,
    "clientPostedJobs": 0,
    "clientJoinedAt": "2023-11-07T05:31:56Z",
    "clientIndustry": "<string>",
    "clientCompanySize": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

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.

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);

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"])

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"}'

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.

{
  "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.

Upwork search: Accepts the job’s title as query. Searches Upwork jobs.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

jobUrl

string

Link to the Upwork job, like https://www.upwork.com/jobs/~021234567890123456789. Send this or jobId.

jobId

string

Upwork job id, like ~021234567890123456789. Send this or jobUrl.

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

Upwork job API

Request

Response

Billing

Authorizations

Body

Response

​Request

​Response

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Billing

Pagination

Related methods