Waitlist API.
Public signup endpoints anyone can hit from a frontend, plus the admin endpoints that drive the console. Every endpoint generated from the live OpenAPI spec.
Waitlist exposes two surfaces. The public surface under /v1/waitlists/{workspace_slug}/{waitlist_slug} needs no auth: your own frontend reads the waitlist config with GET and posts signups to POST .../entries. There is no hosted signup page — you render the form. The admin surface under /v1/workspaces/{workspace_id}/... needs a bearer token (platform session or pcft_live_* key) and covers waitlists, entries, variants, analytics, and webhooks. Both are documented below.
Base URL
https://api.waitlist.productcraft.coAuth
Authorization: Bearer …Spec version
OpenAPI spec
https://api.waitlist.productcraft.co/docs-jsonAnalytics
Per-waitlist sign-up analytics: totals, referral performance, variants and a daily timeline.
Entries
The sign-ups on a waitlist: list, count, read, approve or reject, invite into an Auth app, bulk actions, CSV export, test sign-ups and delete.
- get
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entriesList entries on a waitlist - get
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/countCount the entries on a waitlist - get
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/export.csvExport every entry as CSV - get
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/{entry_id}Get a single entry - patch
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/{entry_id}Approve or reject an entry - delete
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/{entry_id}Delete an entry - post
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/{entry_id}/releaseRelease a held entry from the review queue - post
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/{entry_id}/invite-to-appInvite an entry into a linked Auth app - post
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/bulkApprove, reject or invite up to 100 entries at once - post
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/test-entriesAdd a test signup
Public-Waitlist
The public sign-up surface for your own forms: waitlist info, sign-up and the referral leaderboard. No API key (browser-safe); a waitlist is named by its workspace slug and its own slug.
- get
/v1/waitlists/{workspace_slug}/{waitlist_slug}Public waitlist info (display name, description, custom-field schema, branding hints, active variant) - get
/v1/waitlists/{workspace_slug}/{waitlist_slug}/leaderboard/topPublic referral leaderboard: the top entries by honoured referrals, emails masked. - get
/v1/waitlists/{workspace_slug}/{waitlist_slug}/leaderboardPublic top-50 referral leaderboard. - post
/v1/waitlists/{workspace_slug}/{waitlist_slug}/entriesSubmit a new entry to a public waitlist - post
/v1/waitlists/{workspace_slug}/{waitlist_slug}/entries/confirmConfirm a sign-up (double opt-in) - get
/v1/waitlists/{workspace_slug}/{waitlist_slug}/entries/meRead your own sign-up (entrant status) - post
/v1/waitlists/{workspace_slug}/{waitlist_slug}/entries/resend-confirmationSend the confirmation email again
Stats
Waitlist totals and a daily sign-up series for the workspace dashboard.
Waitlist-Invites
Invite waves (the next N in line into your Auth app or with access codes, now or on a schedule) and access-code redemption.
- get
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/invite-wavesList invite waves - post
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/invite-wavesInvite the next N in line, now or on a schedule - get
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/invite-waves/{wave_id}Get an invite wave - post
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/invite-waves/{wave_id}/cancelCancel a scheduled invite wave - post
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/access-codes/redeemRedeem an access code
Waitlist-Rewards
Referral rewards people reached: hand-out tracking for `entry.milestone_reached`.
Waitlist-Settings
Workspace-wide Waitlist defaults: the sender, email templates, reCAPTCHA and the linked Auth app.
Waitlist-Variants
A/B and locale variants of a waitlist's public copy (name, description, confirmation message).
- get
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/variantsList variants on a waitlist - post
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/variantsCreate a variant - patch
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/variants/{id}Update a variant - delete
/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/variants/{id}Delete a variant
Waitlists
Waitlists (`lists` in the SDKs): create, read, update, open or close for sign-ups (`status`), and delete.
- get
/v1/workspaces/{workspace_id}/waitlistsList waitlists in this workspace - post
/v1/workspaces/{workspace_id}/waitlistsCreate a waitlist (workspace-scoped) - get
/v1/workspaces/{workspace_id}/waitlists/{id}Get waitlist details - patch
/v1/workspaces/{workspace_id}/waitlists/{id}Update waitlist metadata and settings - delete
/v1/workspaces/{workspace_id}/waitlists/{id}Delete a waitlist (cascades to entries) - patch
/v1/workspaces/{workspace_id}/waitlists/{id}/statusChange waitlist status
Webhooks
Webhook endpoints that receive `entry.created`, `entry.approved` and `entry.rejected` events, their delivery log and replays. The legacy per-webhook routes are deprecated.
- get
/v1/workspaces/{workspace_id}/webhooks/event-typesList the events an endpoint can subscribe to. - get
/v1/workspaces/{workspace_id}/webhooks/endpointsList webhook endpoints, oldest first. - post
/v1/workspaces/{workspace_id}/webhooks/endpointsAdd a webhook endpoint. - get
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}Get one webhook endpoint (without its secret). - patch
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}Change a webhook endpoint: URL, description, events, on/off. - delete
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}Delete a webhook endpoint. - post
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}/rotate-secretRotate the signing secret. - post
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}/testSend a test event to this endpoint now and return the result. - get
/v1/workspaces/{workspace_id}/webhooks/eventsList webhook events, newest first (kept for 30 days). - get
/v1/workspaces/{workspace_id}/webhooks/events/{event_id}Get one webhook event with every delivery attempt. - post
/v1/workspaces/{workspace_id}/webhooks/events/{event_id}/replaySend a logged event again, to its endpoints or to one endpoint. - get
/v1/workspaces/{workspace_id}/webhooksList webhooks for the workspace, newest first, cursor-paginated (secrets masked) - post
/v1/workspaces/{workspace_id}/webhooksCreate a workspace webhook. - get
/v1/workspaces/{workspace_id}/webhooks/{id}Get a webhook (secret masked) - patch
/v1/workspaces/{workspace_id}/webhooks/{id}Update url / events / active flag. - delete
/v1/workspaces/{workspace_id}/webhooks/{id}Delete a webhook - get
/v1/workspaces/{workspace_id}/webhooks/{id}/deliveriesDelivery attempts for a webhook, newest first, cursor-paginated (default 50, max 200) - post
/v1/workspaces/{workspace_id}/webhooks/{id}/rotate-secretRotate the signing secret. - post
/v1/workspaces/{workspace_id}/webhooks/{id}/testSend the example of an event to this webhook; the attempt shows in `/deliveries`