List API keys

GET/v1/api-keysAPI key

Returns all of the project's keys, newest first. Revoked and expired keys are included, so check revokedAt and expiresAt. The full key is never returned: Flaresend only stores its first 12 characters and a hash.

Keys are created, renamed and revoked with the admin key. See Create an API key and API keys.

Response

dataApiKey[]

Show API key properties

idstring

The key ID, key_…. This is not the key itself.

projectIdstring

The project it belongs to.

namestring

The name given when it was created, for example production.

mode'live' | 'test'

test keys never send. See Test mode.

prefixstring

The first 12 characters of the key, for example fs_live_4f8K, so you can tell keys apart.

lastUsedAtstring | null

When the key last made a request. Updated at most once a minute.

createdAtstring

When it was created.

revokedAtstring | null

When it was revoked, or null if it's active.

expiresAtstring | null

When it stops working, or null if it never expires.

Request

import { Flaresend } from '@flaresend/client';

const flaresend = new Flaresend({
  apiKey: process.env.FLARESEND_API_KEY!,
  baseUrl: 'https://mailer.example.com',
});

// Returns the array directly, not { data }
const keys = await flaresend.apiKeys.list();

Response

{
  "data": [
    {
      "id": "key_01K5ZQ9A1B2C3D4E5F6G7H8J9K",
      "projectId": "proj_01K5ZQ8M3N6P1R4S7T0V2W5X8Y",
      "name": "production",
      "mode": "live",
      "prefix": "fs_live_4f8K",
      "lastUsedAt": "2026-09-26T14:05:31.123Z",
      "createdAt": "2026-09-20T09:12:44.001Z",
      "revokedAt": null,
      "expiresAt": null
    }
  ]
}

ResponseCopy Anchor Link

Response