List task statuses

​

Lists the columns of your task board — To Do, In Progress and Done, plus any columns your account has added.

This is where you turn a status name into the task_status_id the task endpoints take, whether you are placing a new task in a column, moving an existing one, or filtering a list by column.

Query Parameters
  • page[number]
    Type: integer
    min:  
    1

    Page to return, starting at 1.

  • page[size]
    Type: integer
    min:  
    1
    max:  
    100

    Records per page. Defaults to 25; anything above 100 is reduced to 100.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/public-api/v1/task_statuses
curl https://app.hellobonsai.com/public-api/v1/task_statuses \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "e1c4b06e-3a0f-4a52-9c8f-6a1d2b3c4d5e",
      "status": "In Progress",
      "state": "active",
      "color": "#520EB0",
      "position": 1
    }
  ],
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e",
    "pagination": {
      "page": 1,
      "page_size": 25,
      "has_more": true
    }
  }
}

A page of task statuses, ordered by their position on the board.