Skip to content
Patomic

List API keys belonging to the authenticated user

GET
/v1/keys

Cursor-paginated. Pass the next_cursor from the previous response back as the cursor query parameter to get the next page. Sorted by created_at desc, id desc.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page_size
integer
default: 50 >= 1 <= 200
cursor
string
>= 1 characters <= 2048 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Page of keys for the user, newest first.

object
data
required
Array<object>
object
id
required
string
name
required
string
key_prefix
required
string
rate_limit_rpm
required
number
last_used_at
required
number
nullable
expires_at
required
number
nullable
created_at
required
number
revoked_at
required
number
nullable
next_cursor
required

Opaque cursor for the next page. Pass it back as the cursor query parameter. Null when no more pages exist.

string
nullable

400

Section titled “400 ”

Invalid pagination cursor.

object
error
required
object
type
required
string
Allowed values: authentication_error rate_limit_error invalid_request_error idempotency_error not_found_error internal_error
code
required
string
Allowed values: unauthorized rate_limit_exceeded invalid_idempotency_key idempotency_key_conflict invalid_parameter not_found internal_error
message
required
string
param
required
string
nullable
docs_url
required
string format: uri
request_id
required
string
suggestion
required
string
nullable

401

Section titled “401 ”

Missing or invalid API key.

object
error
required
object
type
required
string
Allowed values: authentication_error rate_limit_error invalid_request_error idempotency_error not_found_error internal_error
code
required
string
Allowed values: unauthorized rate_limit_exceeded invalid_idempotency_key idempotency_key_conflict invalid_parameter not_found internal_error
message
required
string
param
required
string
nullable
docs_url
required
string format: uri
request_id
required
string
suggestion
required
string
nullable

429

Section titled “429 ”

Rate limit exceeded.

object
error
required
object
type
required
string
Allowed values: authentication_error rate_limit_error invalid_request_error idempotency_error not_found_error internal_error
code
required
string
Allowed values: unauthorized rate_limit_exceeded invalid_idempotency_key idempotency_key_conflict invalid_parameter not_found internal_error
message
required
string
param
required
string
nullable
docs_url
required
string format: uri
request_id
required
string
suggestion
required
string
nullable