Admin API

Retrieve a project

Get one project's settings by its slug.

GET/v1/admin/projects/{slug}Admin key

Path parameters

slugstringpathrequired

The project slug, for example acme.

Response

idstring

The project ID, for example proj_01K6B1QZ3M8H2V5T7R9N4XW6CD.

slugstring

The slug used in admin URLs and by RPC callers.

namestring

The display name.

defaultFromstring | null

The sender used when a send has no from.

allowedDomainsstring[]

Domains the project may send from.

allowedSendersstring[] | null

Exact addresses allowed in from, or null for any address on the allowed domains.

domainSendersRecord<string, string>

The default sender per domain. Only domains that have one are listed; {} when none do.

rpcEnabledboolean

Whether Workers may send for this project over the service binding.

dailyLimitinteger

Live emails allowed per UTC day. 0 means no limit.

trackOpensboolean

Default for open tracking on HTML emails.

trackClicksboolean

Default for click tracking on HTML emails.

broadcastsEnabledboolean

Whether broadcasts are allowed.

createdAtstring

ISO 8601 creation time.

updatedAtstring

ISO 8601 time of the last change.

disabledAtstring | null

When the project was disabled, or null. A disabled project's API keys get 403 project_disabled and its RPC calls fail the same way.

Errors

Status	Code	When
404	`project_not_found`	No project has this slug.

Request

const res = await fetch('https://mailer.example.com/v1/admin/projects/acme', {
  headers: { Authorization: `Bearer ${process.env.FLARESEND_ADMIN_KEY}` },
});
const project = await res.json();

Response

{
  "id": "proj_01K6B1QZ3M8H2V5T7R9N4XW6CD",
  "slug": "acme",
  "name": "Acme",
  "defaultFrom": "Acme <hello@acme.com>",
  "allowedDomains": ["acme.com", "mail.acme.com"],
  "allowedSenders": null,
  "domainSenders": {
    "mail.acme.com": "Acme Alerts <alerts@mail.acme.com>"
  },
  "rpcEnabled": true,
  "dailyLimit": 5000,
  "trackOpens": true,
  "trackClicks": false,
  "broadcastsEnabled": false,
  "createdAt": "2026-09-26T10:00:00.000Z",
  "updatedAt": "2026-09-26T12:30:00.000Z",
  "disabledAt": null
}

List projectsGET

Every project on the mailer, oldest first, disabled ones included.

Update a projectPATCH

Change a project's settings. Only the fields you send are changed.