Status abrufen

Status sind pro Unternehmen frei konfigurierbar. Gibt die konfigurierten Status des Unternehmens zurück.

Hinweis: Der Name eines Status ist frei wählbar und unterscheidet sich von Unternehmen zu Unternehmen. Für eine stabile Zuordnung (z.B. in einer externen Anwendung) verwende das Feld type (open, in_progress oder done) statt des Namens.

Request

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

Header

Header	Wert
Authorization	Bearer {access_token}

Query-Parameter

Parameter	Typ	Pflicht	Beschreibung
status	string	Nein	Filtert nach Status, kommagetrennt kombinierbar. Erlaubte Werte: active (nicht gelöscht), deleted. Standard: all (alle Werte). Siehe Konventionen.
offset	integer	Nein	Startposition (Standard: 0)
limit	integer	Nein	Anzahl Ergebnisse (Standard: 50, Max: 200)

Hinweis: Ohne status-Filter sortiert dieser Endpoint nach interner ID aufsteigend, siehe Konventionen.

Response

Erfolg (200 OK)

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

Response-Felder

Feld	Typ	Beschreibung
data[].id	string (UUID)	Eindeutige Status-ID
data[].name	string	Name des Status (frei konfigurierbar pro Unternehmen)
data[].type	string	Stabile Status-Kategorie: open, in_progress oder done
data[].color	string	Farbe des Status (Hex)
data[].deleted	boolean	true, wenn der Status gelöscht wurde
meta.total	integer	Gesamtanzahl der Status (unter Berücksichtigung des status-Filters)
meta.offset	integer	Aktuelle Startposition
meta.limit	integer	Anzahl der zurückgegebenen Einträge

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

Mögliche Fehler

Status	Code	Beschreibung
400	validation_error	status enthält einen ungültigen Wert
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope todos nicht vorhanden