FreelanceOS Upwork API

Public documentation for the Upwork-only API exposed by FreelanceOS.

Base URL

https://api.freelanceos.work

Authentication

All protected endpoints require a bearer token:

Authorization: Bearer <your_api_token>

You can create or copy your token from:

https://app.freelanceos.work/profile

Endpoints

GET /v1/health

Health check for the public API.

Example:

curl https://api.freelanceos.work/v1/health

GET /v1/me

Returns the current API key owner and account metadata.

Authentication required.

Example:

curl \
  -H "Authorization: Bearer <your_api_token>" \
  https://api.freelanceos.work/v1/me

GET /v1/jobs

Returns Upwork jobs collected by the platform.

Authentication required.

Supported query parameters:

page
limit
query
published_after

Notes:

• page is 1-based.
• limit is capped by the API.
• query is a free-text search filter.
• published_after filters jobs by publication date.
• Unsupported query parameters are ignored.

Example:

curl \
  -H "Authorization: Bearer <your_api_token>" \
  "https://api.freelanceos.work/v1/jobs?page=1&limit=10&query=react"

Response Shape

The jobs endpoint returns a paginated JSON payload with a data array.

Each job object currently exposes the following fields:

{
  "id": 12345,
  "platform": "upwork",
  "external_id": "upwork-job-id",
  "title": "React developer needed",
  "description": "Short job description",
  "budget": {
    "type": "hourly",
    "min": 30,
    "max": 50,
    "currency": "USD"
  },
  "skills": ["React", "TypeScript"],
  "url": "https://www.upwork.com/jobs/...",
  "published_at": "2026-06-25T08:15:00Z",
  "client": {
    "country": "US"
  }
}

Example Responses

See the examples/ directory for ready-to-run curl commands and sample JSON payloads.

Scope

This repository contains documentation only:

• API overview
• request examples
• sample responses
• token acquisition instructions

It does not contain application code.