API reference

Everything the dashboard does works through the API too: read entries, invite, delete, and check invitations. The reference comes from the OpenAPI file.

Keys and mode

Waitlists for products that are online but not open yet: collect addresses, confirm them by mail, invite people, and let your sign-up check who is invited.

Every request with a secret key works on exactly one product in exactly one mode: ni_sk_live_… keys see real entries and send real mail, ni_sk_test_… keys see test entries, and their mails only appear in the dashboard.

Errors always look the same: { "error": { "code": "…", "message": "…" } }. Rely on code; message is for humans and may change.

What applies to every call

300 calls per minute per product and mode. Beyond that you get 429 with Retry-After.
With the Idempotency-Key header, a repeat within 24 hours is not carried out twice.
Lists come page by page, with nextCursor for the next page.
Errors always have the same shape, see Errors.

Endpoints

POST/api/v1/subscribePut an address on the waitlist
GET/api/v1/leaderboardRead the referral leaderboard
GET/api/v1/entriesList entries
POST/api/v1/entries/invite-nextInvite the next people in line
GET/api/v1/entries/{id}Read one entry
DELETE/api/v1/entries/{id}Delete one entry
POST/api/v1/entries/{id}/inviteInvite one entry
POST/api/v1/entries/{id}/reinviteSend an invitation again
POST/api/v1/entries/{id}/move-upMove an entry up the line
GET/api/v1/invitedAsk whether an address is invited (address in the URL)
POST/api/v1/invitedAsk whether an address is invited
POST/api/v1/invites/verifyCheck an invitation code
POST/api/v1/invites/redeemUse an invitation code up

OpenAPI

This reference is generated from the OpenAPI file. You can load the same file into Postman, Insomnia or a code generator. Open the OpenAPI file