integrationSettings

Requires permission settings:integration:read.

Lists the organization's integrations, highest priority first and then by service name. Needs settings:integration: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 IntegrationSettings {
  integrationSettings {
    id
    displayName
    serviceName
    createdAt
    config
    description
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query IntegrationSettings {\n  integrationSettings {\n    id\n    displayName\n    serviceName\n    createdAt\n    config\n    description\n  }\n}"
}
EOF

Response:

{
  "data": {
    "integrationSettings": [
      {
        "id": "id",
        "displayName": "string",
        "serviceName": "AMAZON",
        "createdAt": "2025-01-15T00:00:00Z",
        "config": {},
        "description": "string"
      }
    ]
  }
}

integrationSettings: [IntegrationSetting!]!

Type

IntegrationSetting object

An integration setting.