Get all statuses
Retrieve the list of statuses that can be assigned to leads in your campaigns.
When to use. Build a status picker, or map your own codes to a status, before working with leads. To fetch a single status by its id, use GET /statuses/{id}.
Parameters. id (query, optional): return only the status with this id. campaign_id (query, optional): return only statuses that belong to this campaign. You can also filter, order, limit and select fields by any response field. See Core API Concepts.
Returns. { "statuses": [ ... ] }, where each entry has id, campaign_id, name and code.
Example. GET /api/statuses/campaign_id/2
Request
- Base URLhttps://api.commpeak.com/dialer
- URLhttps://api.commpeak.com/dialer/{sub_domain}/api/statuses
- AuthAPI key in header Authorization
Path parameters
Dialer Name (subdomain)
Query parameters
Filter by status ID.
Filter by campaign ID.
Response
Successful Response
Example response
{
"statuses": [
{
"campaign_id": 395,
"id": 7479,
"name": "Busy"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.