integrationByService

Requires permission settings:integration:read.

Returns the organization's integration for one service, or null when it has none. Secrets are never returned. Requires permission to read integrations.

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 IntegrationByService($serviceName: IntegrationService!) {
  integrationByService(serviceName: $serviceName) {
    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 IntegrationByService($serviceName: IntegrationService!) {\n  integrationByService(serviceName: $serviceName) {\n    id\n    displayName\n    serviceName\n    createdAt\n    config\n    description\n  }\n}",
  "variables": {
    "serviceName": "AMAZON"
  }
}
EOF

Variables:

{
  "serviceName": "AMAZON"
}

Response:

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

integrationByService(
  serviceName: IntegrationService!
): IntegrationSetting

Arguments

integrationByService.serviceName ● IntegrationService! non-null enum

The service to look up.

Type

IntegrationSetting object

An integration setting.