Waitlist API reference

Waitlist API · Waitlist-Rewards

get/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/milestone-awardsAuth

List reached referral milestones

Every time an entry reaches one of the waitlist's referral rewards (`settings.referral_rewards`) it is recorded here once, `entry.milestone_reached` fires and the milestone email goes out. Use the list to hand rewards out and `PATCH` to mark them done.

Path parameters

workspace_id*string · uuid

Id of the workspace.

waitlist_id*string · uuid

Id of the waitlist.

Query parameters

fulfilledboolean

`false`: only rewards not handed out yet; `true`: only handed out.

limitinteger

Page size.

cursorstring

Cursor from the previous page's `pagination.next_cursor`.

Response · 200 A page of awards.

data*array

Awards 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}/milestone-awards
Authorization: Bearer YOUR_TOKEN

Response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "waitlist_id": "00000000-0000-0000-0000-000000000000",
      "entry_id": "00000000-0000-0000-0000-000000000000",
      "milestone_count": 3,
      "reward": "Skip the line",
      "awarded_at": "2026-01-01T00:00:00.000Z",
      "fulfilled_at": "2026-01-01T00:00:00.000Z",
      "email": "ada@example.com",
      "name": "Ada",
      "referral_count": 3
    }
  ],
  "pagination": {
    "next_cursor": "eyJwb3NpdGlvbiI6MjB9",
    "has_more": false
  }
}