Skip to main content
GET
Get an API key

Authorizations

X-API-Key
string
header
required

Path Parameters

api_key_id
string<uuid>
required

Response

Successful Response

created_at
string<date-time>
required
id
string<uuid>
required
key_prefix
string
required

The first characters of the key's value, so it can be told apart from another in a list. The value itself is shown once, when the key is created, and is not recoverable afterwards.

name
string
required
org_id
string
required
scope
enum<string>
required

What the key may do. A read key may call read endpoints only; a write key may call everything the workspace's plan allows.

Available options:
read,
write
updated_at
string<date-time>
required
expire_at
string<date-time> | null
last_used_at
string<date-time> | null

When this key last authenticated a request, to the minute.