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
header
required

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.

Required range: x > 1
​
page-size
integer
default:
20

The maximum size of the pages.

Required range: 1 < x < 50
​
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 data after or equal to the specified date.

​
before

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

Response

200 - application/json
​
alias
string | null
required

The alias of the API key.

​
createdAt
string
required

The date and time when the API key was created.

​
handle
string
required

The handle of the API key. Is unique.

​
id
string
required

The UUID of the API key. Is unique.

​
token
string
required

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

OverviewCreate