Retrieve the current key

Find out which project and key a request is using. A cheap way to check a key works.

GET/v1/meAPI key

Returns the project and the key that made the request. It reads nothing else, so it's the quickest way to check that a key is valid and the mailer is reachable, for example in a health check or right after deploying a new key.

Response

project{ id, slug, name }

The project the key belongs to.

key{ id, name, mode }

The key: its ID, its name and whether it's live or test.

Errors

Status	Code	When
401	`missing_api_key`, `invalid_api_key`, `revoked_api_key`, `expired_api_key`	The key doesn't work. See Authentication.
403	`project_disabled`	The project is disabled.

Request

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

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

const { project, key } = await flaresend.me();

Response

{
  "project": {
    "id": "proj_01K5ZQ8M3N6P1R4S7T0V2W5X8Y",
    "slug": "acme",
    "name": "Acme"
  },
  "key": {
    "id": "key_01K5ZQ9A1B2C3D4E5F6G7H8J9K",
    "name": "production",
    "mode": "live"
  }
}

ResponseCopy Anchor Link

ErrorsCopy Anchor Link

Response

Errors