v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Statuses

Get all statuses

Use the Get all statuses endpoint if you want to retrieve a list of statuses. You can specify per status id or campaign id.

Response

The response will be a JSON object with a statuses array containing status objects. Each status object will have the following properties:

id (string): The ID of the status.
campaign_id (string): The ID of the campaign associated with the status.
name (string): The name of the status.
code (null): The code associated with the status, if available.

get/statuses

Query parameters

fieldsstring

Example:campaign_id;name

Response

Successful operation / Successful operation

Example response

{
  "statuses": [
    {
      "campaign_id": "1",
      "code": null,
      "id": "1",
      "name": "New"
    },
    {
      "campaign_id": "1",
      "code": "FinantickCustomer-NoAnswer",
      "id": "2",
      "name": "Call Again"
    }
  ]
}