apiKeys

Requires at least one of the permissions settings:api:read or settings:tenant:read.

List all API keys for your organization

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 ApiKeys {
  apiKeys {
    id
    name
    createdAt
    allowedIps
    expiresAt
    isActive
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ApiKeys {\n  apiKeys {\n    id\n    name\n    createdAt\n    allowedIps\n    expiresAt\n    isActive\n  }\n}"
}
EOF

Response:

{
  "data": {
    "apiKeys": [
      {
        "id": "id",
        "name": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "allowedIps": [
          "string"
        ],
        "expiresAt": "2025-01-15T00:00:00Z",
        "isActive": true
      }
    ]
  }
}

apiKeys: [ApiKeyResult!]!

Type

ApiKeyResult object

An API key. The full key is never shown again after it is created.