/v1/waitlists/{workspace_slug}/{waitlist_slug}Public waitlist info (display name, description, custom-field schema, branding hints, active variant)
What your sign-up form renders: the copy (from the variant served for this request's language, if any), the custom fields, the reCAPTCHA site key, referral rewards and brand hints. Only an `active` waitlist answers; anything else is 404 `WAITLIST_NOT_FOUND`. No API key.
Path parameters
workspace_slug*stringSlug of the workspace that owns the waitlist (a renamed workspace's old slug still resolves).
waitlist_slug*stringSlug of the waitlist within its workspace.
Query parameters
langstringBCP-47 locale tag (e.g. `en`, `pt-BR`). Wins over Accept-Language when picking the variant.
Response · 200 Public waitlist info
slug*stringWaitlist slug.
workspace_slug*stringWorkspace slug the request resolved against.
canonical_workspace_slug*stringCanonical workspace slug. When the request URL used a stale slug, compare with the URL slug and 301-redirect.
display_name*stringDisplay name (active variant copy wins over the stored name).
description*stringDescription (active variant copy wins over the stored one); null when unset.
status*stringAlways `active` — non-active waitlists return 404.
custom_fields*arrayCustom fields to render on your sign-up form; submit their values in the entry `metadata`.
confirmation_message*stringMessage to show after a successful signup.
recaptcha_site_key*stringreCAPTCHA v3 site key. When non-null, POST .../entries requires a `recaptcha_token` created with the action `waitlist_signup`.
referral_rewards*objectmilestones*arrayMilestones sorted by count, ascending. Empty when the waitlist has no referral rewards configured.
variant*objectActive A/B or locale variant served for this request; null when none configured.
brand*objectbrand_name*stringWorkspace brand name from the Waitlist settings; null when unset.
brand_logo_url*string · uriWorkspace logo URL from the Waitlist settings; null when unset.
primary_color*stringPrimary brand colour as #RRGGBB.
Example
Request
GET https://api.waitlist.productcraft.co/v1/waitlists/{workspace_slug}/{waitlist_slug}Response
{
"slug": "string",
"workspace_slug": "string",
"canonical_workspace_slug": "string",
"display_name": "string",
"description": "string",
"status": "string",
"custom_fields": [
{
"key": "company",
"label": "Company",
"type": "text",
"required": false,
"options": [
"string"
]
}
],
"confirmation_message": "string",
"recaptcha_site_key": "string",
"referral_rewards": {
"milestones": [
{
"count": 3,
"reward": "Skip the queue"
}
]
},
"variant": {},
"brand": {
"brand_name": "string",
"brand_logo_url": "string",
"primary_color": "string"
}
}