Skip to main content
GET
/
contacts
/
statuses
curl -X GET "https://api.guayaba.ai/contacts/statuses" \
  -H "X-API-Key: gua_a1b2c3d4_your-api-key-here"

[
  {
    "id": "a1b2c3d4-0000-0000-0000-000000000001",
    "name": "active",
    "label": "Active",
    "description": null,
    "color": "#10B981",
    "isTerminal": false,
    "isSystem": true,
    "excludeFromStats": false,
    "displayOrder": 0
  },
  {
    "id": "a1b2c3d4-0000-0000-0000-000000000002",
    "name": "fulfilled",
    "label": "Fulfilled",
    "description": null,
    "color": "#6366F1",
    "isTerminal": true,
    "isSystem": true,
    "excludeFromStats": false,
    "displayOrder": 2
  },
  {
    "id": "a1b2c3d4-0000-0000-0000-000000000003",
    "name": "paused",
    "label": "Paused",
    "description": null,
    "color": "#F59E0B",
    "isTerminal": true,
    "isSystem": false,
    "excludeFromStats": false,
    "displayOrder": 3
  }
]
Returns all contact statuses available for your team. Use the name field values when filtering contacts via List Contacts or updating a contact via Update Contact.

​
Response

Returns an array of status objects.
​
name
string
The status identifier. Use this value in filter and update requests.
​
label
string
Human-readable display name shown in the Guayaba dashboard.
​
description
string or null
Optional description of the status.
​
color
string
Hex color code used to represent this status in the UI.
​
isTerminal
boolean
If true, contacts in this status will not receive any scheduled calls, SMS, or WhatsApp messages.
​
isSystem
boolean
If true, this is a built-in system status that cannot be deleted.
​
excludeFromStats
boolean
If true, contacts with this status are excluded from campaign statistics.
​
displayOrder
number
Numeric order used to render statuses in the dashboard UI.
curl -X GET "https://api.guayaba.ai/contacts/statuses" \
  -H "X-API-Key: gua_a1b2c3d4_your-api-key-here"

[
  {
    "id": "a1b2c3d4-0000-0000-0000-000000000001",
    "name": "active",
    "label": "Active",
    "description": null,
    "color": "#10B981",
    "isTerminal": false,
    "isSystem": true,
    "excludeFromStats": false,
    "displayOrder": 0
  },
  {
    "id": "a1b2c3d4-0000-0000-0000-000000000002",
    "name": "fulfilled",
    "label": "Fulfilled",
    "description": null,
    "color": "#6366F1",
    "isTerminal": true,
    "isSystem": true,
    "excludeFromStats": false,
    "displayOrder": 2
  },
  {
    "id": "a1b2c3d4-0000-0000-0000-000000000003",
    "name": "paused",
    "label": "Paused",
    "description": null,
    "color": "#F59E0B",
    "isTerminal": true,
    "isSystem": false,
    "excludeFromStats": false,
    "displayOrder": 3
  }
]