v1
latestOpenAPI 3.0.02026-08-061280285.2 KBSequence APIs
Reference data for the sequence APIs.
<br/>Returns the lookup lists needed to build requests to the other sequence<br/>endpoints, in a single call:<br/><br/> - status: the statuses a sequence can be in. These id values are what<br/> the status filter of /api/external/sequences/list expects. The<br/> internal "Deleted" status is intentionally excluded.<br/> - type: sequence targets (Candidate or Contact). These id values are<br/> what the sequence_type_ids filter of /api/external/sequences/list<br/> expects, and they determine which prospects may be added to a sequence.<br/>
get/api/external/sequences/reference-data
Headers
RF-Api-Keystring
Response
Sequence reference data (statuses and types)
{"stackTrail":"paths:/api/external/sequences/reference-data:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":{"status":[{"id":1,"name":"Draft"},{"id":2,"name":"In Progress"},{"id":3,"name":"Paused"},{"id":4,"name":"Archived"},{"id":5,"name":"Completed"},{"id":6,"name":"Scheduled"}],"type":[{"id":1,"name":"Candidate"},{"id":2,"name":"Contact"}]}}}
Example response
{
"data": {
"status": [
{
"id": 1,
"name": "Draft"
},
{
"id": 2,
"name": "In Progress"
},
{
"id": 3,
"name": "Paused"
},
{
"id": 4,
"name": "Archived"
},
{
"id": 5,
"name": "Completed"
},
{
"id": 6,
"name": "Scheduled"
}
],
"type": [
{
"id": 1,
"name": "Candidate"
},
{
"id": 2,
"name": "Contact"
}
]
}
}