tenantSettingsSummary

Requires permission settings:tenant:read.

Returns how many settings the organization has (all, active and customized), the settings grouped by category, and when any was last changed. 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 TenantSettingsSummary {
  tenantSettingsSummary {
    activeSettings
    customSettings
    lastUpdated
    totalSettings
    groups {
      displayName
      category
      count
      description
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query TenantSettingsSummary {\n  tenantSettingsSummary {\n    activeSettings\n    customSettings\n    lastUpdated\n    totalSettings\n    groups {\n      displayName\n      category\n      count\n      description\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "tenantSettingsSummary": {
      "activeSettings": 0,
      "customSettings": 0,
      "lastUpdated": "2025-01-15T00:00:00Z",
      "totalSettings": 0,
      "groups": [
        {
          "displayName": "string",
          "category": "ACCOUNTING",
          "count": 0,
          "description": "string"
        }
      ]
    }
  }
}

tenantSettingsSummary: SettingsSummary!

Type

SettingsSummary object

Headline figures about the settings.