This organisation's own settings

GET

/api/settings

const url = 'https://app.dycrypt.com/o/acme/api/settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.dycrypt.com/o/acme/api/settings \
  --header 'Authorization: Bearer <token>'

Readable by anyone in the organisation, tokens included: the timezone is what every figure here is cut in, so anything reading those figures needs to be able to say so.

Authorizations

orgToken

Responses

200

The settings.

application/json

object

timezone

required

The IANA zone every chart in this organisation buckets by.

string

updatedAt

string | null format: date-time

updatedBy

Who last set it.

string | null

Example

{
  "timezone": "Europe/Paris"
}

401

No credential, or one that no longer resolves — revoked, expired, deleted. Replace it.

application/json

Every failure in this API has this shape and no other.

object

error

required

string

Example

{
  "error": "this token does not have licenses:write"
}

403

Authenticated, but not allowed: a missing scope, a read-only role, a plan limit reached, or a credential used under another organisation’s slug. The right credential doing something it may not do.

application/json

Every failure in this API has this shape and no other.

object

error

required

string

Example

{
  "error": "this token does not have licenses:write"
}