API reference
Read preferences
Read email preferences and time zone.
GET
/api/v1/preferencesaccount:readMCP: prefs_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/preferences' \ -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"
- prefs
- object
- time_zone
- string
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"
},
"prefs": {
"type": "object",
"properties": {
"due_soon": {
"type": "boolean"
},
"overdue": {
"type": "boolean"
},
"script_changed": {
"type": "boolean"
},
"changes_requested": {
"type": "boolean"
},
"delivery_approved": {
"type": "boolean"
}
},
"required": [
"due_soon",
"overdue",
"script_changed",
"changes_requested",
"delivery_approved"
],
"additionalProperties": false
},
"time_zone": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"ok",
"api_version",
"prefs",
"time_zone"
],
"additionalProperties": false
}