Create a task list

POST /v1/lists

Creates a new task list in the team the API key is bound to. The API key’s owner is automatically granted access to the new list.

Connected web clients receive a realtime tasklists refetch event so the new list shows up in their sidebar without a page reload.

Request

No path parameters.

Body

Content-Type: application/json

Field	Type	Required	Description
name	string	yes	Name of the new task list. Must contain at least one non-whitespace character.
color	string	no	Color tag for the list. Defaults to Green when omitted.

Valid color values: Gray, Red, Orange, Yellow, Amber, Lime, Green, Teal, Sky, Blue, Purple, Pink.

Example request

{
  "name": "Q3 launch",
  "color": "Blue"
}

Response

201 Created — the created list:

Field	Type	Description
id	number	Numeric ID of the new list.
name	string	Display name of the list.
color	string	Color tag the list was created with.
isArchived	boolean	Always false for a freshly created list.

Example response

{
  "id": 27,
  "name": "Q3 launch",
  "color": "Blue",
  "isArchived": false
}

400 Bad Request is returned with { "error": "..." } when name is missing or empty, or when color is not one of the valid values.