API reference
Read earnings
Read earnings shared by clients, grouped by currency. Supply from and to as YYYY-MM, at most 24 months.
GET
/api/v1/earningsearnings:readMCP: earnings
Request
Examples use sample IDs and upload handles. Replace them with values returned for your assigned work before making a call.
curl -X GET 'https://talent.radioworkflow.com/api/v1/earnings?from=2026-09&to=2026-10' \ -H "Authorization: Bearer $TALENT_API_KEY"
Request fields
All requests use a bearer API key.
fromqueryRequiredstring
Pattern: ^\d{4}-\d{2}$
toqueryRequiredstring
Pattern: ^\d{4}-\d{2}$
customer_idqueryOptionalstring | null
Default: null
Complete request schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}$"
},
"to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}$"
},
"customer_id": {
"anyOf": [
{
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"from",
"to"
],
"additionalProperties": false
}Response
HTTP 200 returns a JSON object. Read ok before using its fields. IDs are decimal strings, instants are Unix seconds, and a missing value is null.
- ok
- true
- api_version
- "1"
- from
- string
- to
- string
- rates_visible_any
- boolean
- lines
- object[]
- totals
- object
- hidden_customers
- object[]
- unrated_jobs
- integer
- truncated
- boolean
Complete response schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"const": true
},
"api_version": {
"type": "string",
"const": "1"
},
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}$"
},
"to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}$"
},
"rates_visible_any": {
"type": "boolean"
},
"lines": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "object",
"properties": {
"job_id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
"customer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"key_number": {
"type": "string"
},
"advertiser": {
"type": "string"
},
"requested_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"month": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}$"
},
"status": {
"type": "string",
"enum": [
"pending",
"completed",
"declined"
]
},
"stage": {
"type": "string",
"enum": [
"sent",
"viewed",
"accepted",
"changes_requested",
"delivered",
"completed",
"approved",
"declined"
]
},
"amount": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"pattern": "^-?\\d+\\.\\d{2}$"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"symbol": {
"type": "string",
"minLength": 1
}
},
"required": [
"amount",
"currency",
"symbol"
],
"additionalProperties": false
}
},
"required": [
"job_id",
"customer",
"key_number",
"advertiser",
"requested_at",
"month",
"status",
"stage",
"amount"
],
"additionalProperties": false
}
},
"totals": {
"type": "object",
"properties": {
"overall": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"symbol": {
"type": "string",
"minLength": 1
},
"amount": {
"type": "string",
"pattern": "^-?\\d+\\.\\d{2}$"
},
"jobs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"currency",
"symbol",
"amount",
"jobs"
],
"additionalProperties": false
}
},
"by_customer": {
"type": "array",
"items": {
"type": "object",
"properties": {
"customer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"amount": {
"type": "string",
"pattern": "^-?\\d+\\.\\d{2}$"
},
"jobs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"customer",
"currency",
"amount",
"jobs"
],
"additionalProperties": false
}
},
"by_month": {
"type": "array",
"items": {
"type": "object",
"properties": {
"month": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}$"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"amount": {
"type": "string",
"pattern": "^-?\\d+\\.\\d{2}$"
},
"jobs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"month",
"currency",
"amount",
"jobs"
],
"additionalProperties": false
}
}
},
"required": [
"overall",
"by_customer",
"by_month"
],
"additionalProperties": false
},
"hidden_customers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"unrated_jobs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"truncated": {
"type": "boolean"
}
},
"required": [
"ok",
"api_version",
"from",
"to",
"rates_visible_any",
"lines",
"totals",
"hidden_customers",
"unrated_jobs",
"truncated"
],
"additionalProperties": false
}