Waitlist API reference

Waitlist API · Waitlist-Invites

get/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/invite-wavesAuth

List invite waves

Newest first, cursor-paginated.

Path parameters

workspace_id*string · uuid

Id of the workspace.

waitlist_id*string · uuid

Id of the waitlist.

Query parameters

limitinteger

Page size. Defaults to 20; values above 100 are clamped.

cursorstring

Opaque cursor from the previous page's `pagination.next_cursor`. Omit for the first page.

Response · 200 A page of waves.

data*array

Waves on this page, newest first.

pagination*object
next_cursor*string

Opaque cursor for the next page. `null` when no more pages are available.

Example: "eyJwb3NpdGlvbiI6MjB9"

has_more*boolean

True iff another page exists; if true, pass `next_cursor` on the next request.

Example: false

Example

Request

GET https://api.waitlist.productcraft.co/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/invite-waves
Authorization: Bearer YOUR_TOKEN

Response

{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {
    "next_cursor": "eyJwb3NpdGlvbiI6MjB9",
    "has_more": false
  }
}