List API keys

GET

/v1/tenant/api-keys

const url = 'https://api.keliplay.com/v1/tenant/api-keys?limit=200&offset=0&sort=createdAt&dir=asc&status=active';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.keliplay.com/v1/tenant/api-keys?limit=200&offset=0&sort=createdAt&dir=asc&status=active' \
  --header 'Authorization: Bearer <token>'

Lists your API keys. The secret part of a key is never returned after it is created.

total counts keys matching your filters. active and allTotal count all your keys, ignoring filters.

Permission: settings.read.

Authorizations

apiKey

Parameters

Query Parameters

limit

integer

default: 200 >= 1 <= 200

Items per page.

offset

integer

Items to skip before the page starts.

search

string

<= 200 characters

Match part of a key’s name or prefix, ignoring case.

sort

string

default: createdAt

Allowed values: createdAt name lastUsedAt

Field to sort by. Keys never used sort last by lastUsedAt.

dir

string

default: desc

Allowed values: asc desc

Sort direction.

status

string

Allowed values: active revoked

Only active or only revoked keys.

Responses

200

A page of keys.

application/json

object

apiKeys

required

Array<object>

object

required

string

name

required

string

keyPrefix

required

The part of the key after krds_sk_, shown so you can tell keys apart.

string

permissions

required

The permissions the key carries. See Permission.

Array<string>

lastUsedAt

required

string | null format: date-time

revokedAt

required

string | null format: date-time

createdAt

required

string format: date-time

total

required

integer

active

required

Keys not revoked, across your account.

integer

allTotal

required

All keys, across your account.

integer

Example

{
  "apiKeys": [
    {
      "id": "0192f3a1-0000-7000-8000-0000000ce001",
      "name": "Production backend",
      "keyPrefix": "a1b2c3d4e5f6",
      "permissions": [
        "tokens.mint",
        "campaigns.read",
        "results.read"
      ],
      "lastUsedAt": "2026-10-05T09:41:00.000Z",
      "revokedAt": null,
      "createdAt": "2026-09-01T09:00:00.000Z"
    }
  ],
  "total": 1,
  "active": 1,
  "allTotal": 1
}

400

The request is not valid. details lists each field that failed, where there is one.

application/json

object

error

required

object

code

required

Stable and safe to branch on.

invalid_request (400): the request is not valid.
unauthorized (401): missing, malformed or revoked API key.
upgrade_required (402): not in your plan, or a plan limit is reached.
forbidden (403): the key lacks a permission, or the action is not allowed.
not_found (404): nothing with that id in your account.
conflict (409): clashes with the current state.
confirmation_required (409): repeat with confirm=true. Folder deletion only.
rate_limited (429): wait for Retry-After seconds.
internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>
object

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

Example

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid request json.",
    "details": [
      {
        "path": "name",
        "message": "Too small, expected string to have >=1 characters"
      }
    ]
  }
}

401

The API key is missing, malformed or revoked.

application/json

object

error

required

object

code

required

Stable and safe to branch on.

invalid_request (400): the request is not valid.
unauthorized (401): missing, malformed or revoked API key.
upgrade_required (402): not in your plan, or a plan limit is reached.
forbidden (403): the key lacks a permission, or the action is not allowed.
not_found (404): nothing with that id in your account.
conflict (409): clashes with the current state.
confirmation_required (409): repeat with confirm=true. Folder deletion only.
rate_limited (429): wait for Retry-After seconds.
internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>
object

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or revoked API key."
  }
}

403

The API key does not carry the permission this needs, or the request is not allowed.

application/json

object

error

required

object

code

required

Stable and safe to branch on.

invalid_request (400): the request is not valid.
unauthorized (401): missing, malformed or revoked API key.
upgrade_required (402): not in your plan, or a plan limit is reached.
forbidden (403): the key lacks a permission, or the action is not allowed.
not_found (404): nothing with that id in your account.
conflict (409): clashes with the current state.
confirmation_required (409): repeat with confirm=true. Folder deletion only.
rate_limited (429): wait for Retry-After seconds.
internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>
object

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

Example

{
  "error": {
    "code": "forbidden",
    "message": "Your role does not allow this (draws.run)."
  }
}