/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/invite-waves/{wave_id}AuthGet an invite wave
Its status and progress: `invited_total`, `failed_total`, `last_error`, `next_run_at`. Never the saved API key.
Path parameters
workspace_id*string · uuidId of the workspace.
waitlist_id*string · uuidId of the waitlist.
wave_id*string · uuidId of the wave.
Response · 200 The wave.
id*string · uuidWave id.
waitlist_id*string · uuidThe waitlist.
size*integerPeople per run.
method*object`auth` (Auth app invites) or `code` (access codes).
app_slug*stringAuth app (`auth`).
send_email*booleanWhether invitees are emailed.
status*object`scheduled` waits for `next_run_at` (a repeating wave goes back to it after each run); `running`; `done`; `failed` (nothing could be invited, see `last_error`); `canceled`.
next_run_at*string · date-timeWhen it runs next (scheduled waves); null otherwise.
repeat_every_hours*integerRepeats every N hours; null runs once.
runs*integerRuns so far.
invited_total*integerInvited across all runs.
failed_total*integerFailed across all runs.
last_run_at*string · date-timeWhen it last ran.
last_error*stringThe last failure, if any.
has_api_key*booleanWhether an API key is saved for scheduled `auth` runs (never returned).
created_by*string · uuidWho created it (platform user or API key subject).
created_at*string · date-timeWhen it was created.
updated_at*string · date-timeWhen it last changed.
Example
Request
GET https://api.waitlist.productcraft.co/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/invite-waves/{wave_id}
Authorization: Bearer YOUR_TOKENResponse
{
"id": "00000000-0000-0000-0000-000000000000",
"waitlist_id": "00000000-0000-0000-0000-000000000000",
"size": 0,
"method": {},
"app_slug": "string",
"send_email": false,
"status": {},
"next_run_at": "2026-01-01T00:00:00.000Z",
"repeat_every_hours": 0,
"runs": 0,
"invited_total": 0,
"failed_total": 0,
"last_run_at": "2026-01-01T00:00:00.000Z",
"last_error": "string",
"has_api_key": false,
"created_by": "00000000-0000-0000-0000-000000000000",
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}