tenantSettingByKey

Requires permission settings:tenant:read.

Returns one active setting by category and key, or null when there is none. Needs settings:tenant:read.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query TenantSettingByKey($category: String!, $key: String!) {
  tenantSettingByKey(category: $category, key: $key) {
    id
    createdAt
    category
    dataType
    description
    enteredBy
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query TenantSettingByKey($category: String!, $key: String!) {\n  tenantSettingByKey(category: $category, key: $key) {\n    id\n    createdAt\n    category\n    dataType\n    description\n    enteredBy\n  }\n}",
  "variables": {
    "category": "string",
    "key": "string"
  }
}
EOF

Variables:

{
  "category": "string",
  "key": "string"
}

Response:

{
  "data": {
    "tenantSettingByKey": {
      "id": "id",
      "createdAt": "2025-01-15T00:00:00Z",
      "category": "ACCOUNTING",
      "dataType": "ARRAY",
      "description": "string",
      "enteredBy": "string"
    }
  }
}

tenantSettingByKey(
  category: String!
  key: String!
): TenantSetting

Arguments

tenantSettingByKey.category ● String! non-null scalar

The settings category. Not case sensitive.

tenantSettingByKey.key ● String! non-null scalar

The setting's key within the category.

Type

TenantSetting object

A setting of the organization.