/apikeys

GET /apikeys

Get all apikeys for the current user's account

Retrieve a paginated list of apikeys with optional filtering

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

Try it out

Output:

Responses

Description

Successful response

[
  {
    "id": 0,
    "description": "string",
    "expiresAt": "string",
    "permissions": [
      {}
    ],
    "apiKey": "string",
    "lastFourOfSecret": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
]

References

#/components/parameters/xAccountIdHeader #/components/schemas/ApiKey #/components/schemas/ApiKeysList

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/ApiKey

OpenAPI
TypeScript

type: object
required:
  - description
  - apiKey
properties:
  id:
    type: integer
    readOnly: true
  description:
    type: string
    description: Description of the API key
  expiresAt:
    type: string
    format: date-time
    nullable: true
    description: ISO date-time string when the API key expires, or null/empty for no
      expiration
  permissions:
    type: array
    items:
      type: object
  apiKey:
    type: string
  lastFourOfSecret:
    type: string
  createdAt:
    type: string
    format: date-time
    readOnly: true
  updatedAt:
    type: string
    format: date-time
    readOnly: true

>
export interface ApiKey {
  id?: number;
  /** Description of the API key */
  description: string;
  /** ISO date-time string when the API key expires, or null/empty for no expiration */
  expiresAt?: Date;
  permissions?: {}[];
  apiKey: string;
  lastFourOfSecret?: string;
  createdAt?: Date;
  updatedAt?: Date;
}

#/components/schemas/ApiKeysList

OpenAPI
TypeScript

type: array
items:
  $ref: "#/components/schemas/ApiKey"

|
export type ApiKeysList = ApiKey[];

Route Source Code

Check out the source code for this route entrypoint here: /apikeys/route.ts

Or the swagger.yaml spec this documentation was generated from: /apikeys/swagger.yaml