A valid request URL is required to generate request examples{
"status": "success",
"code": "<string>",
"data": [
{
"id": 123,
"name": "<string>",
"userDefinedId": "<string>",
"state": "active",
"properties": [
"<string>"
]
}
],
"pagination": {
"hasMore": true,
"cursor": "<string>"
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Get color groups
Retrieves a paginated list of color groups. Supply filter + sort + pageSize + pageNumber for page-based results, or a cursor for cursor-based results. cursor is mutually exclusive with filter/sort/pageSize/pageNumber.
A valid request URL is required to generate request examples{
"status": "success",
"code": "<string>",
"data": [
{
"id": 123,
"name": "<string>",
"userDefinedId": "<string>",
"state": "active",
"properties": [
"<string>"
]
}
],
"pagination": {
"hasMore": true,
"cursor": "<string>"
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Query Parameters
A free-text term matched as a substring against both the color group name and userDefinedId.
Filters to color groups whose name exactly matches this value.
Filters to color groups whose userDefinedId exactly matches this value.
Filters the results to color groups in the given state. Whether the color group is active and available for assigning to colors, or has been deactivated.
active, inactive 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, Name, UserDefinedId.
Show child attributes
Show child attributes
The maximum number of color groups to return per page. Defaults to 30, maximum 100.
The 1-based page number to return. Defaults to 1.
An opaque keyset pagination token from a previous response. Mutually exclusive with the filter, sort, pageSize and pageNumber parameters.
Response
OK
The coarse outcome of the request, indicating whether it succeeded or failed.
success, error The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.
The page of results, always an array. An empty page is an empty array rather than null or an omitted field.
Show child attributes
Show child attributes
Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.
Show child attributes
Show child attributes