Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Account Colors

Account Colors are the colors available on a user's account that can be used to style workspaces.

Fetching a list of Account Colors

Each project in Kantata OX can be tagged with a Project Color for categorization purposes. The colors that are available for projects are defined at the account level. Use the id of Account Color to read and update Project Colors using the workspaces endpoint.

This endpoint returns structured Account Color objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the account_colors top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
enabled_only
boolean
Default: true

Include only the colors that are enabled on the account.

matching
string

Limits account colors to names matching the specified query.

only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
Responses
200

A list of Account Colors have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/account_colors
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "account_colors": {
    }
}
➔ Next to Account Invitations