Skip to main content
GET
List care instruction icons.

Headers

X-Delogue-Api
string

Query Parameters

Free-text search matching the icon's identifier, custom ID, or text.

Id
integer<int64>

Filters to the single icon with this exact identifier.

CustomId
string

Filters to icons whose custom ID exactly matches this value. The match is case-sensitive.

Text
string

Filters to icons whose text contains this value. The match is case-insensitive.

State
string

Filters icons by lifecycle state. Values match the state shown in the response.

Region
string

Filters icons by care-labelling region. Values match the region shown in the response.

IconType
string

Filters icons by care instruction category. Values match the icon type shown in the response.

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, CustomId, Text, Region, State.

pageSize

Number of items per page. Defaults to 30, maximum 100.

pageNumber

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

cursor
string

Opaque keyset pagination token. 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.