List references

A todo can be linked to other records, e.g. a diagnosis or an appointment. These links are deliberately not part of the todo object — resolving the targets is expensive, so they are fetched through this separate endpoint.

Returns the references of a todo.

Note: Todos are only soft-deleted. Their references survive a delete and remain readable via this endpoint. The todo itself becomes immutable afterwards: POST and DELETE on /references then return 400.

Note: References whose target the client may not see are filtered out silently. meta.total therefore counts only the references visible to the client, not everything stored.

Request

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

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string	Yes	Unique todo ID

Query parameters

Parameter	Type	Required	Description
offset	integer	No	Start position (default: 0)
limit	integer	No	Number of results (default: 50, max: 200)

Response

Success (200 OK)

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "type": "MedicalDiagnosis",
      "target": "c3d4e5f6-a7b8-9012-cdef-234567890123"
    }
  ],
  "meta": {
    "total": 3,
    "offset": 0,
    "limit": 50
  }
}

Response fields

Field	Type	Description
data[].id	string (UUID)	Unique reference ID
data[].type	string	Type of the linked target (see Required scopes). For older references this can be a historical value (e.g. invoice or MedicalReceiptPosition) that POST does not accept — recreating the reference with that type is therefore not possible
data[].target	string (UUID) | null	UUID of the linked record, without an embedded short designation. For the types MedicalExternalLetter, MedicalMotherChildPass, MedicalPsychotherapy, MedicalReceipt, DVPReportEntry, and Transmission there is no dedicated OAuth endpoint to look them up — the UUID identifies the target without being resolvable here
meta.total	integer	Number of references visible to the client
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/b2c3d4e5-f6a7-8901-bcde-f01234567890/references?offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *string

offset integer

limit integer

Zuerst Token anfordern

Possible errors

Status	Code	Description
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope todos not present
404	not_found	Todo not found