Skip to main content
GET
List care instructions.

Headers

X-Delogue-Api
string

Query Parameters

Free-text term matched against the care instruction's identifier, customer-defined reference code, and display text.

Ids
integer<int64>[]

Restricts results to care instructions with these identifiers.

UserDefinedIds
string[]

Restricts results to care instructions whose customer-defined reference code is one of these values.

Text
string

Restricts results to care instructions whose display text contains this value.

State
enum<string>

Filters care instructions by their lifecycle state. The deleted value cannot be used for filtering. Lifecycle state of the care instruction. The deleted value is only a bulk-update transport marker and is never returned in responses.

Available options:
active,
inactive,
deleted
sort
object[]

Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id, UserDefinedId, Text, Position, State.

pageSize

The maximum number of results to return per page. Defaults to 30, maximum 100.

pageNumber

The 1-based page number to return. Defaults to 1.

cursor
string

An opaque keyset pagination token for fetching the next page. Mutually exclusive with the filter, sort, pageSize, and pageNumber parameters.

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
object[]
required

The page of results, always an array. An empty page is an empty array rather than null or an omitted field.

pagination
object
required

Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.