Waitlist API reference

Waitlist API · Public-Waitlist

get/v1/waitlists/{workspace_slug}/{waitlist_slug}/leaderboard/top

Public referral leaderboard: the top entries by honoured referrals, emails masked.

The same rows as the deprecated `GET …/leaderboard`, in a `{ data }` envelope. Not paginated: at most 50 rows. Anonymous read with the same access policy as the public waitlist info. No API key.

Path parameters

workspace_slug*string

Slug of the workspace that owns the waitlist (a renamed workspace's old slug still resolves).

waitlist_slug*string

Slug of the waitlist within its workspace.

Query parameters

limitinteger

Number of rows, 1 to 50. Defaults to 50; larger values are clamped to 50.

Response · 200 The leaderboard.

data*array

Entries with the most honoured referrals, most first (at most `limit`, up to 50).

Example

Request

GET https://api.waitlist.productcraft.co/v1/waitlists/{workspace_slug}/{waitlist_slug}/leaderboard/top

Response

{
  "data": [
    {
      "position": 12,
      "referral_count": 4,
      "masked_email": "a***@example.com"
    }
  ]
}