Waitlist API reference

Waitlist API · Waitlist-Settings

get/v1/workspaces/{workspace_id}/waitlist/settingsAuth

Read workspace-level Waitlist defaults

The settings plus `email_setup` (whether Waitlist emails can go out and what is missing; the sender domain and template names are checked against Mail, cached for up to 60 seconds) and `skipped_sends` (emails not sent in the last 7 days because the setup was incomplete). Waitlist never falls back to a ProductCraft sender: an email that cannot go out is recorded, not sent.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Response · 200 Workspace Waitlist settings with the email setup state.

workspace_id*string · uuid

The workspace.

default_sender_domain_id*string · uuid

Mail domain UUID used as default sender for Waitlist notifications.

default_heimdall_app_slug*string

Auth consumer-app slug approved entries are invited into.

brand_name*string

Brand name for Waitlist emails and the public info; null when unset.

brand_logo_url*string

Logo URL for Waitlist emails and the public info; null when unset.

primary_color*string

Primary brand colour as #RRGGBB

notifications_via_envoi*boolean

Whether Waitlist notifications are routed through the Mail service.

sender_mode*object

Where the From comes from: `workspace` (the workspace default sender set in Mail; the default) or `custom` (`default_sender_domain_id` + `default_sender_address`). Workspaces that had an address before this setting existed are `custom`.

Example: "workspace"

effective_sender*object

The sender Waitlist emails actually go out from, with its live status in Mail.

default_sender_address*string

The From used when `sender_mode` is `custom`.

welcome_template_name*string

Mail template sent on sign-up; null when unset.

approved_template_name*string

Mail template sent when an entry is approved; null when unset.

rejected_template_name*string

Mail template sent when an entry is rejected; null when unset.

updated_at*string · date-time

null when the workspace has no explicit settings row yet.

email_setup*object

Whether Waitlist emails can go out and, if not, what is missing. Computed on the server on every read.

skipped_sends*object

Emails Waitlist did not send in the last 7 days because the setup was incomplete.

Example

Request

GET https://api.waitlist.productcraft.co/v1/workspaces/{workspace_id}/waitlist/settings
Authorization: Bearer YOUR_TOKEN

Response

{
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "default_sender_domain_id": "00000000-0000-0000-0000-000000000000",
  "default_heimdall_app_slug": "string",
  "brand_name": "string",
  "brand_logo_url": "string",
  "primary_color": "string",
  "notifications_via_envoi": false,
  "sender_mode": "workspace",
  "effective_sender": {},
  "default_sender_address": "string",
  "welcome_template_name": "string",
  "approved_template_name": "string",
  "rejected_template_name": "string",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "email_setup": {},
  "skipped_sends": {}
}