A valid request URL is required to generate request examples{
"status": "success",
"code": "<string>",
"data": [
{
"styleId": 123,
"colorId": 123,
"name": "<string>",
"customId1": "<string>",
"customId2": "<string>",
"colorReference": "<string>",
"colorNote": "<string>",
"state": "active",
"colorLanguages": [
{
"languageId": 123,
"languageName": "<string>",
"languageCode": "<string>",
"colorName": "<string>"
}
],
"colorGroups": [
{
"id": 123,
"name": "<string>",
"userDefinedId": "<string>",
"state": "active"
}
],
"customFields": [
{
"id": 123,
"customId1": "<string>",
"type": "<string>",
"name": "<string>",
"value": {
"id": 123,
"value": "<string>",
"customId": "<string>"
},
"values": [
{
"id": 123,
"value": "<string>",
"customId": "<string>"
}
],
"perColorValues": [
{
"styleColorId": 123,
"value": {
"id": 123,
"value": "<string>",
"customId": "<string>"
},
"values": [
{
"id": 123,
"value": "<string>",
"customId": "<string>"
}
]
}
]
}
],
"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>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Lists enriched style colors across the organization.
Cross-style list, filterable by styleId/colorId/state. Each row carries the same enriched customFields[] (per-color values resolved in, master-style backfill otherwise) and properties[] (“hasCustomFieldOverrides”) as the style-scoped routes; customFields[] is always present and carries master values when the CustomFieldsPerColor module is off. 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. Cursor is strongly recommended given the table’s size (millions of rows across organizations).
A valid request URL is required to generate request examples{
"status": "success",
"code": "<string>",
"data": [
{
"styleId": 123,
"colorId": 123,
"name": "<string>",
"customId1": "<string>",
"customId2": "<string>",
"colorReference": "<string>",
"colorNote": "<string>",
"state": "active",
"colorLanguages": [
{
"languageId": 123,
"languageName": "<string>",
"languageCode": "<string>",
"colorName": "<string>"
}
],
"colorGroups": [
{
"id": 123,
"name": "<string>",
"userDefinedId": "<string>",
"state": "active"
}
],
"customFields": [
{
"id": 123,
"customId1": "<string>",
"type": "<string>",
"name": "<string>",
"value": {
"id": 123,
"value": "<string>",
"customId": "<string>"
},
"values": [
{
"id": 123,
"value": "<string>",
"customId": "<string>"
}
],
"perColorValues": [
{
"styleColorId": 123,
"value": {
"id": 123,
"value": "<string>",
"customId": "<string>"
},
"values": [
{
"id": 123,
"value": "<string>",
"customId": "<string>"
}
]
}
]
}
],
"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>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Query Parameters
Limits the results to color assignments on this style.
Limits the results to assignments of this color.
Limits the results by assignment state. A deleted value behaves the same as inactive, and when omitted only active assignments are returned. Lifecycle state of the color group, indicating whether it is available for use.
active, inactive, deleted 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: StyleId, StyleColorRowId, ColorId, Name.
Show child attributes
Show child attributes
Number of items per page. Defaults to 30, maximum 100.
The 1-based page number to return. Defaults to 1.
Opaque keyset pagination token. 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