List API Keys

GET 
/organizations/:organizationId/api-keys

List all API keys for the organization. Note: The key hash/secret is NEVER returned - only the prefix for identification.

Request

Path Parameters

organizationId stringrequired

Organization ID

Query Parameters

includeRevoked boolean

Default value: false

Whether to include revoked keys

Responses

200

application/json

Schema

Schema

data object[]required
Array of API keys
Array [
]

Example (from schema)

{
  "data": [
    {}
  ]
}

Example

{}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

Loading...