List API tokens

GET

/api-tokens

• Production API

Authorizations

• bearerAuth
• cookieAuth

Parameters

Query Parameters

tokenIds

Comma-separated list of token IDs to filter by

string

nullable

Comma-separated list of token IDs to filter by

teamId

Filter tokens by team ID

string

Filter tokens by team ID

roles

Comma-separated list of roles to filter by (admin, member, readonly)

string

nullable

Comma-separated list of roles to filter by (admin, member, readonly)

isActive

Filter by active status: true for active, false for revoked

boolean

nullable

Filter by active status: true for active, false for revoked

page

Page number for pagination (1-indexed)

number

>= 1

Page number for pagination (1-indexed)

pageSize

Number of results per page (1-100, default: 20)

number

>= 1 <= 100

Number of results per page (1-100, default: 20)

orderBy

Field to sort results by

string

Allowed values: createdAt name

Field to sort results by

orderDirection

Sort direction: ascending or descending

string

Allowed values: asc desc

Sort direction: ascending or descending

Responses

200

API tokens retrieved successfully

object

apiTokens

required

Array of API tokens matching the query

Array<object>

object

tokenId

required

Unique identifier for the API token (nanoid format)

string

teamId

required

ID of the team this token provides access to

string

name

required

Human-readable name for identifying this token

string

tokenPrefix

required

Prefix of the token for identification (e.g., ‘cat_tok_’)

string

last4

required

Last 4 characters of the token for verification

string

role

required

Permission level: ‘admin’ (full access), ‘member’ (standard access), ‘readonly’ (read-only access)

string

Allowed values: admin member readonly

createdByUserId

required

ID of the user who created this token

string

expiresAt

required

When the token expires (ISO 8601), or null if no expiration

string format: date-time

nullable

lastUsedAt

required

When the token was last used for an API request (ISO 8601)

string format: date-time

nullable

isActive

required

Whether the token is active and can be used for authentication

boolean

createdAt

required

When the token was created (ISO 8601)

string format: date-time

updatedAt

required

When the token was last modified (ISO 8601)

string format: date-time

total

required

Total number of tokens matching the query (before pagination)

number

page

required

Current page number

number

pageSize

required

Number of results per page

number

400

Bad Request - Validation error or invalid input

object

error

required

string

code

string

details

nullable

retryable

boolean

401

Unauthorized - Authentication required or invalid token

object

error

required

string

code

string

details

nullable

retryable

boolean

403

Forbidden - Insufficient permissions

object

error

required

string

code

string

details

nullable

retryable

boolean