Get all task statuses in a firm

GET /api/v1/task-status

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Query parameters

per_page integer

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

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

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
  
  position integer
  
  is_type_completed boolean
  
  is_archived boolean
  
  is_not_started boolean

GET /api/v1/task-status

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

Response examples (200)

{
  "data": [
    {
      "name": "Incomplete",
      "uuid": "77a163af-b02d-4114-b77d-41a48c08534b",
      "colour": "#398898",
      "position": 1,
      "created_at": "2025-07-17T16:23:21+01:00",
      "updated_at": "2025-07-17T16:23:21+01:00",
      "is_archived": false,
      "is_not_started": false,
      "is_type_completed": false
    }
  ]
}