Skip to main content
GET
/
opportunity-statuses
curl "https://api.clustr-ai.com/api/public/opportunity-statuses" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "data": {
    "statuses": [
      {
        "id": "8f652e61-edfa-4a8c-8763-cc4902dd386b",
        "name": "Assigned",
        "color": "#3B82F6",
        "position": 0,
        "is_terminal": false
      },
      {
        "id": "5566db32-2792-4162-852b-7db42af804fa",
        "name": "Contacted",
        "color": "#6366F1",
        "position": 1,
        "is_terminal": false
      },
      {
        "id": "cbfd0074-57bd-4fa7-a5fc-8bb5392b16c9",
        "name": "Meeting Booked",
        "color": "#06B6D4",
        "position": 3,
        "is_terminal": false
      },
      {
        "id": "7e4cc70e-2644-4b1e-9006-57222533dde4",
        "name": "Not Interested",
        "color": "#EF4444",
        "position": 5,
        "is_terminal": true
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.clustr-ai.com/llms.txt

Use this file to discover all available pages before exploring further.

List all custom opportunity statuses configured for your tenant. Use the returned status IDs with the Update Opportunity endpoint.

​
Response Fields

​
statuses
array
Array of status objects, ordered by position.
​
statuses[].id
string
Status UUID — pass this as status_id when updating an opportunity.
​
statuses[].name
string
Display name (e.g. “Assigned”, “Contacted”, “Meeting Booked”).
​
statuses[].color
string
Hex color code for UI display (e.g. #3B82F6).
​
statuses[].position
integer
Display order (0-based). Lower values appear first.
​
statuses[].is_terminal
boolean
Whether this status represents a final state (e.g. “Won”, “Not Interested”, “Archived”).
curl "https://api.clustr-ai.com/api/public/opportunity-statuses" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "data": {
    "statuses": [
      {
        "id": "8f652e61-edfa-4a8c-8763-cc4902dd386b",
        "name": "Assigned",
        "color": "#3B82F6",
        "position": 0,
        "is_terminal": false
      },
      {
        "id": "5566db32-2792-4162-852b-7db42af804fa",
        "name": "Contacted",
        "color": "#6366F1",
        "position": 1,
        "is_terminal": false
      },
      {
        "id": "cbfd0074-57bd-4fa7-a5fc-8bb5392b16c9",
        "name": "Meeting Booked",
        "color": "#06B6D4",
        "position": 3,
        "is_terminal": false
      },
      {
        "id": "7e4cc70e-2644-4b1e-9006-57222533dde4",
        "name": "Not Interested",
        "color": "#EF4444",
        "position": 5,
        "is_terminal": true
      }
    ]
  }
}