Get an API key

Retrieve an API key by ID for the authenticated organization. API keys are masked.

GET/org/api_keys/{id}

Retrieve an API key by ID for the authenticated organization. API keys are masked.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

API key ID

Query Parameters

include_deleted?boolean

When true, return the API key even if it has been deleted (soft-deleted), for audit purposes. Defaults to false, which returns 404 for a deleted key.

Defaultfalse

Response

application/json

API key details

id*string

Unique API key identifier

name*string

Label for the API key. API keys are not addressable by name; use the ID or key identifier for stable references.

created_at*string

When the API key was created

Formatdate-time

created_by*

expires_at*string

When the API key expires

Formatdate-time

deleted_at*string

When the API key was deleted (soft-deleted). Null for keys that have not been deleted.

Formatdate-time

project_id*string

Project identifier for project-scoped API keys. Null means org-wide.

project_name*string

Project name for project-scoped API keys. Null means the key is org-wide or the project name is unavailable.

masked_key*string

Masked version of the API key

curl -X GET "https://example.com/org/api_keys/string"

{  "id": "string",  "name": "string",  "created_at": "2019-08-24T14:15:22Z",  "created_by": {    "id": "string",    "email": "user@example.com",    "name": "string"  },  "expires_at": "2019-08-24T14:15:22Z",  "deleted_at": "2019-08-24T14:15:22Z",  "project_id": "string",  "project_name": "string",  "masked_key": "string"}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}