List Keys

apiId

string

required

The ID of the api you want to retrieve.

limit

int

default: 100

Limit the number of returned keys, the maximum is 100.

offset

int

default: 0

Specify an offset for pagination.

Example: An offset of 4 will skip the first 4 keys and return keys starting at the 5th position.

ownerId

string

Filter by ownerId.

If provided, this will only return keys where the ownerId matches.

result

keys

Array

required

id

string

required

The unique key id, use this to reference the key directly when fetching or revoking.

apiId

string

required

The API id where this key belongs to.

workspaceId

string

required

The workspace id where this key belongs to.

start

string

required

The first few characters of the key. This can be useful when displaying it your users, so they can match it.

name

string

The name you gave this key.

ownerId

string

Your user’s Id. This will provide a link between Unkey and your customer record.

When validating a key, we will return this back to you, so you can clearly identify your user from their api key.

meta

object

This is a place for dynamic meta data, anything that feels useful for you should go here

Example:

{
  "billingTier": "PRO",
  "trialEnds": "2023-06-16T17:16:37.161Z"
}

createdAt

int

required

When the key was created, unix timestamp in milliseconds.

expires

int

If set, this is when the key ceases to exist, unix timestamp in milliseconds. Once keys expire they will automatically be deleted and are no longer valid.

remaining

int

How many more times this key can be used.

ratelimit

Object

The ratelimit of this key, if configured.

total

int

required

How many keys in total there are in this API. Useful to paginate through this endpoint.

Official Libraries

Community Libraries

Request

Response

Official Libraries

Community Libraries

​Request

​Response

Request

Response