API reference
Read availability
Read working days and same-day availability.
GET
/api/v1/availabilityaccount:readMCP: availability_get
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/availability' \ -H "Authorization: Bearer $TALENT_API_KEY"
Request fields
All requests use a bearer API key.
No request fields.
Complete request schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false,
"required": []
}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"
- days
- integer[]
- same_day
- boolean
- mixed
- boolean
- rows
- object[]
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"
},
"days": {
"maxItems": 7,
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 7
}
},
"same_day": {
"type": "boolean"
},
"mixed": {
"type": "boolean"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"voice": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"customer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"days": {
"maxItems": 7,
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 7
}
},
"same_day": {
"type": "boolean"
},
"agency": {
"type": [
"string",
"null"
]
}
},
"required": [
"voice",
"customer",
"days",
"same_day",
"agency"
],
"additionalProperties": false
}
}
},
"required": [
"ok",
"api_version",
"days",
"same_day",
"mixed",
"rows"
],
"additionalProperties": false
}