Skip to content

Account Colors

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

Operations

Fetching a list of Account Colors

Request

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.

Query
enabled_onlyboolean

Include only the colors that are enabled on the account.

Default:true
matchingstring

Limits account colors to names matching the specified query.

onlystring

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.

pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
GET
/account_colors
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/account_colors?enabled_only=true&matching=string&only=string&page=1&per_page=20'

Responses

A list of Account Colors have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
account_colorsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "account_colors": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "default_color": true,
      "enabled": true,
      "hex": "string",
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "default_color": true,
      "enabled": true,
      "hex": "string",
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}