GET
/
user
/
keys

To learn how to use the token of an API key to authenticate your API requests, read the bearer tokens page.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default: 1

The index of the page.

page-size
integer
default: 20

The maximum size of the pages.

sort
enum<string>
default: handle

The criteria used to sort the keys.

Available options:
handle,
createdAt
search
string

The term used to search the keys by handle or alias.

after

The term used to search keys after or equal to the specified date.

before

The term used to search keys before or equal to the specified date.

Response

200 - application/json
id
string
required

The UUID of the API key. Is unique.

handle
string
required

The handle of the API key. Is unique.

alias
string | null
required

The alias of the API key.

token
string
required

The Base64-encoded bearer token of the API key. Is unique.

createdAt
string
required

The date and time when the API key was created.

OverviewCreate