Get all Color Collections

Version 4.0.24.2 (latest)

Get an array of all existing Color Collections

Get a single color collection by id with ColorCollection

Get all standard color collections with ColorCollection

Get all custom color collections with ColorCollection

Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return Not Found (404) errors.

Request

GET /color_collections
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields.

Response

200: ColorCollections

Datatype
Description
(array)
id
string
Unique Id
label
string
Label of color collection
categoricalPalettes
Expand DiscretePalette definition...
id
string
Unique identity string
label
string
Label for palette
type
string
Type of palette
colors
string[]
sequentialPalettes
Expand ContinuousPalette definition...
id
string
Unique identity string
label
string
Label for palette
type
string
Type of palette
stops
Expand ColorStop definition...
color
string
CSS color string
offset
integer
Offset in continuous palette (0 to 100)
divergingPalettes
Expand ContinuousPalette definition...
id
string
Unique identity string
label
string
Label for palette
type
string
Type of palette
stops
Expand ColorStop definition...
color
string
CSS color string
offset
integer
Offset in continuous palette (0 to 100)

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

Examples