Skip to content

Get todo ​

Returns the details of a single todo.

Note: This endpoint returns the todo even if it has been deleted (deleted: true).

Request ​

GET /api/oauth/v2/resource/todos/{uuid}

HeaderValue
AuthorizationBearer {access_token}

URL parameters ​

ParameterTypeRequiredDescription
uuidstringYesUnique todo ID

Response ​

Success (200 OK) ​

json
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "number": "A-0001",
    "name": "Call back patient",
    "description": "Call back about rescheduling the appointment",
    "priority": "normal",
    "dueDate": "2026-06-10T00:00:00+02:00",
    "status": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "tags": ["e5f6a7b8-9012-3456-ef01-567890123456"],
    "assignedTo": "d4c5b6a7-8901-2345-6789-0abcdef12345",
    "customer": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
    "createdAt": "2026-06-01T08:15:00+02:00",
    "updatedAt": "2026-06-08T11:42:00+02:00",
    "createdBy": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
    "updatedBy": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
    "deleted": false,
    "deletedAt": null
  }
}

Response fields ​

FieldTypeDescription
data.idstring (UUID)Unique todo ID
data.numberstringSequential todo number (e.g. A-0001)
data.namestringTitle of the todo
data.descriptionstring | nullDescription
data.prioritystringPriority (low, medium, normal, high, critical)
data.dueDatestring | nullDue date (ISO 8601, time of day is always 00:00:00)
data.statusstring (UUID) | nullAssigned status. Look up via Get status
data.tagsArray (string, UUID)UUIDs of the assigned tags. Look up via Get tag
data.assignedTostring (UUID) | nullAssigned staff member. Look up via GET /users/{uuid}
data.customerstring (UUID) | nullAssigned customer. Look up via GET /customers/{uuid}
data.createdAtstringCreation timestamp (ISO 8601)
data.updatedAtstringTimestamp of the last change (ISO 8601)
data.createdBystring (UUID) | nullUser who created the todo. Look up via GET /users/{uuid}
data.updatedBystring (UUID) | nullUser who made the last change
data.deletedbooleantrue if the todo has been deleted
data.deletedAtstring (ISO 8601) | nullDeletion timestamp, null if not deleted
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/todos/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Possible errors ​

StatusCodeDescription
401invalid_clientInvalid or missing access token
403insufficient_scopeScope todos not present
404not_foundTodo not found

Offisy GmbH