Get all client statuses

GET /api/v1/client-status

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Query parameters

filter[uuid] string

Filter by a comma separated list of UUIDs.
sort string

Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC. Defaults to 'name'.
per_page integer

Number of results to return with pagination (Default 15. Max 500).

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  colour string

GET /api/v1/client-status

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/client-status' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "name": "On Hold",
      "uuid": "5e0020bc-c9e2-4b9f-9712-ebafeef2026b",
      "colour": "#FFFFFF",
      "created_at": "2025-06-25T15:10:42+01:00",
      "updated_at": "2025-06-25T15:10:42+01:00"
    }
  ]
}