Get statuses

Statuses are freely configurable per company. Returns the company's configured statuses.

Note: The name of a status is freely chosen and differs from company to company. For a stable mapping (e.g. in a third-party application), use the type field (open, in_progress, or done) instead of the name.

Request

GET /api/oauth/v2/resource/todos/statuses

Header

Header	Value
Authorization	Bearer {access_token}

Query parameters

Parameter	Type	Required	Description
status	string	No	Filters by status, combinable as a comma-separated list. Allowed values: active (not deleted), deleted. Default: all (all values). See Conventions.
offset	integer	No	Start position (default: 0)
limit	integer	No	Number of results (default: 50, max: 200)

Note: Without a status filter, this endpoint sorts by internal ID ascending, see Conventions.

Response

Success (200 OK)

{
  "data": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
      "name": "Open",
      "type": "open",
      "color": "#00adba",
      "deleted": false
    },
    {
      "id": "d4e5f6a7-b8c9-0123-def0-456789012345",
      "name": "In progress",
      "type": "in_progress",
      "color": "#f59e0b",
      "deleted": false
    },
    {
      "id": "e5f6a7b8-c9d0-1234-ef01-567890123456",
      "name": "Done",
      "type": "done",
      "color": "#10b981",
      "deleted": false
    }
  ],
  "meta": {
    "total": 3,
    "offset": 0,
    "limit": 50
  }
}

Response fields

Field	Type	Description
data[].id	string (UUID)	Unique status ID
data[].name	string	Name of the status (freely configurable per company)
data[].type	string	Stable status category: open, in_progress, or done
data[].color	string	Color of the status (hex)
data[].deleted	boolean	true if the status has been deleted
meta.total	integer	Total number of statuses (considering the status filter)
meta.offset	integer	Current start position
meta.limit	integer	Number of returned entries

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/todos/statuses?status=all&offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

status string

offset integer

limit integer

Zuerst Token anfordern

Possible errors

Status	Code	Description
400	validation_error	status contains an invalid value
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope todos not present