Get specific status

Retrieve a single status by its numeric id.

When to use. Drill down to one status's details, for example after picking it from the list returned by GET /statuses. Returns 404 if the id does not exist.

Parameters. id (path, required): the id of the status to fetch.

Returns. { "statuses": [ <status> ] }, containing the requested status with id, campaign_id, name and code.

Example. GET /api/statuses/5283

get/{sub_domain}/api/statuses/{id}

Request

Base URL
https://api.commpeak.com/dialer
URL
https://api.commpeak.com/dialer/{sub_domain}/api/statuses/{id}
Auth
API key in header Authorization

Path parameters

idinteger required

Status ID.

sub_domainstring required

Dialer Name (subdomain)

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.