Waitlist API reference

Waitlist API · Public-Waitlist

get/v1/waitlists/{workspace_slug}/{waitlist_slug}/entries/me

Read your own sign-up (entrant status)

What an entrant sees on their status page: status, place in line, referral code and link, referral count and progress to the next reward. Needs the `token` from the signed link in the Waitlist emails (confirmation and welcome); there is no lookup by email address, so nobody can find out who signed up. The hosted status page and its embeddable widget call this; call it yourself to build your own. No API key.

Path parameters

workspace_slug*string

Slug of the workspace that owns the waitlist (a renamed workspace's old slug still resolves).

waitlist_slug*string

Slug of the waitlist within its workspace.

Query parameters

token*string

The `token` query parameter of the status link from the email.

Response · 200 The entry, as its owner sees it.

status*object

Where the sign-up stands. `pending`: waiting for approval; `approved`: in; `rejected`: not offered a place; `unconfirmed`: email not confirmed yet.

rank*integer

Place in line as the owner sees it: 1 + the confirmed sign-ups ahead, after referral boosts. Null while `unconfirmed`, after `rejected`, and for a test sign-up.

Example: 12

referral_code*string

Referral code of this sign-up.

Example: "464QTHE0"

referral_count*integer

Confirmed sign-ups that used this referral code.

Example: 3

confirmed_at*string · date-time

When the email address was confirmed; null when the waitlist does not ask, or not yet.

waitlist_name*string

Display name of the waitlist.

Example: "Early Access Program"

referral_link*string · uri

The share link: the waitlist's `signup_page_url` with `?ref=<referral_code>`. Null when the waitlist has no sign-up page set; share `referral_code` instead.

Example: "https://acme.com/early-access?ref=464QTHE0"

referral_boost*integer

Places each confirmed referral moves this entry up.

Example: 5

rewards*object

Progress towards the waitlist's referral rewards.

status_url*string · uri

This entry's status link (hosted, or the waitlist's own `status_page_url` with `?token=`). Treat it like a password: whoever has it sees this entry.

status_page_url*string · uri

The waitlist's own status page, when it has one; the hosted page redirects there.

Example

Request

GET https://api.waitlist.productcraft.co/v1/waitlists/{workspace_slug}/{waitlist_slug}/entries/me

Response

{
  "status": {},
  "rank": 12,
  "referral_code": "464QTHE0",
  "referral_count": 3,
  "confirmed_at": "2026-01-01T00:00:00.000Z",
  "waitlist_name": "Early Access Program",
  "referral_link": "https://acme.com/early-access?ref=464QTHE0",
  "referral_boost": 5,
  "rewards": {},
  "status_url": "string",
  "status_page_url": "string"
}