Skip to content
/
List statuses
Last updated

List statuses

List all user statuses available for an organization.

GEThttps://api.aitronos.com/v1/organizations/{organization_id}/statuses

Path parameters

  • organization_id string Required
    • Organization ID (org_ prefixed string)

Query parameters

  • active_only boolean Optional
    • Only return active statuses
    • Default: true

Returns

Array of Status objects.

Bash
curl "https://api.aitronos.com/v1/organizations/org_abc123/statuses" \
  -H "X-API-Key: $FREDDY_API_KEY"

Response:

[
  {
    "id": "status_active",
    "name": "Active",
    "description": "Active member",
    "color": "#00FF00",
    "is_base_status": true,
    "order": 1,
    "organization_id": "org_abc123"
  },
  {
    "id": "status_inactive",
    "name": "Inactive",
    "description": "Inactive member",
    "color": "#FF0000",
    "is_base_status": true,
    "order": 2,
    "organization_id": "org_abc123"
  },
  {
    "id": "status_pending",
    "name": "Pending",
    "description": "Pending approval",
    "color": "#FFA500",
    "is_base_status": true,
    "order": 3,
    "organization_id": "org_abc123"
  }
]

Status object

{
  "id": "status_abc123",
  "name": "Active",
  "description": "Active member",
  "color": "#00FF00",
  "is_base_status": true,
  "order": 1,
  "organization_id": "org_abc123"
}
Previous page
Next page