Skip to main content
GET
Get colors

Headers

X-Delogue-Api
string

Query Parameters

Free-text search across color name, reference and custom identifiers.

Ids
integer<int64>[]

Filters to colors with any of these identifiers.

Name
string

Filters colors by name.

UserDefinedIds
string[]

Filters to colors with any of these primary customer-defined identifiers.

UserDefinedId2s
string[]

Filters to colors with any of these secondary customer-defined identifiers.

ColorReference
string

Filters colors by reference code, such as a Pantone code.

ColorNote
string

Filters colors by note text.

State
enum<string>

Filters colors by lifecycle state. Omit to return all non-deleted colors. Lifecycle state of the color group, indicating whether it is available for use.

Available options:
active,
inactive,
deleted
ColorGroupIds
integer<int64>[]

Filters to colors belonging to any of these color groups.

ColorGroupNames
string[]

Filters to colors belonging to color groups with any of these names.

ColorGroupUserDefinedIds
string[]

Filters to colors belonging to color groups with any of these customer-defined identifiers.

ColorGroupState
enum<string>

Filters colors by the lifecycle state of their color groups. Lifecycle state of the color group, indicating whether it is available for use.

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: Name, UserDefinedId, UserDefinedId2, ColorReference, Id.

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 from a previous response. 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.