Settings

Settings control the way the platform works and acts.

Endpoints
   GET /:project/settings
   GET /:project/settings/:id
  POST /:project/settings
 PATCH /:project/settings/:id
DELETE /:project/settings/:id

The Setting Object

Attributes

id integer

Unique identifier for the setting.

key string

Name of the setting

value string

Value of the setting

Setting Object
{
  "id": 1,
  "key": "project_color",
  "value": "#abcabc"
}

List the Settings

List the settings.

Parameters

project required

The project you're targetting.

Query

limit optional

A limit on the number of objects that are returned. Default is 200. Learn more

offset optional

How many items to skip when fetching data. Default is 0. Learn more

page optional

Cursor for use in pagination. Often used in combination with limit. Learn more

single optional

Return the result as if it was a single item. Useful for selecting a single item based on filters and search queries. Will force limit to be 1. Learn more

meta optional

What metadata to return in the response. Learn more

Returns

Returns an array of setting objects.

Endpoint
   GET /:project/settings
Response
{
  "data": [
    {
      "id": 1,
      "key": "project_url",
      "value": ""
    },
    { ... },
    { ... }
  ]
}

Retrieve a Setting

Retrieve a single setting by unique identifier.

Parameters

project required

The project you're targetting.

id required

Unique identifier of the item.

Query

meta optional

What metadata to return in the response. Learn more

Returns

Returns the setting object for the given unique identifier.

Endpoint
   GET /:project/settings/:id
Response
{
  "data": {
    "id": 1,
    "key": "project_color",
    "value": "#abcabc"
  }
}

Create a Setting

Create a new setting.

Parameters

project required

The project you're targetting.

Attributes

key required

Key for the setting

value optional

Value for the setting

Query

meta optional

What metadata to return in the response. Learn more

Returns

Returns the setting object for the setting that was just created.

Endpoint
  POST /:project/settings
Request
{
  "key": "my_custom_setting"
}
Response
{
  "data": {
    "id": 23,
    "key": "my_custom_setting",
    "value": null
  }
}

Update a Setting

Update an existing setting

Parameters

project required

The project you're targetting.

id required

Unique identifier of the item.

Attributes

key optional

Key for the setting

value optional

Value for the setting

Query

meta optional

What metadata to return in the response. Learn more

Returns

Returns the setting object for the setting that was just updated.

Endpoint
 PATCH /:project/settings/:id
Request
{
  "value": "15"
}
Response
{
  "data": {
    "id": 23,
    "key": "my_custom_setting",
    "value": "15"
  }
}

Delete a Setting

Delete an existing setting

Parameters

project required

The project you're targetting.

id required

Unique identifier of the item.

Returns

Returns an empty body with HTTP status 204

Endpoint
DELETE /:project/settings/:id