Skip to content

List API keys

GET
/v1/api-keys

Keys without any secret material

object
data
required
Array<object>
object
id
required
string
name
required
string
env
required
string
Allowed values: test live
scopes
required
Array<string>
prefix
required

First 12 characters, to recognise the key.

string
created_at
required
string
last_used_at
required
string | null
revoked_at
required
string | null
created_by
required
string | null
next_cursor
required
string | null

The request is not valid

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

Not signed in, or the API key is not valid

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

Not allowed for this role or key

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W