Skip to content

List waitlist entries

The waitlist.entries.list operation: GET /api/v1/waitlist_entries in the REST API and the waitlist_entries_list tool in the MCP server.

GET/api/v1/waitlist_entries

Lists the brand's waitlist in the mode of the request, newest first: customers who asked to be told when the brand can sell in their country (spec §23), with what they wanted to buy and its value. status: pending entries haven't confirmed their email yet. Filter by country or status; page with limit and starting_after. Emails are customer data: show them only to people who need them.

At a glance

  • REST: GET /api/v1/waitlist_entries
  • MCP tool: waitlist_entries_list
  • Operation ID: waitlist.entries.list
  • Scope: Brand
  • Permission: waitlist:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Pagination: limit (at most 100) and starting_after
  • Authentication: API key with the waitlist:read scope
  • Since: M4

Request

Query parameters

FieldTypeRequiredDescription
limitinteger (1 to 100)No
starting_afterwl_… IDNo
countrystringNoOnly entries for this country.
statusone of pending, confirmedNoOnly pending or only confirmed entries.

Response

200 OK with a JSON object, a page of the list (newest first):

FieldTypeDescription
dataarray of object
data[].idwl_… ID
data[].object"waitlist_entry"
data[].livemodeboolean
data[].entityIdent_… ID
data[].brandIdbrd_… ID
data[].emailstring
data[].countrystring
data[].subdivisionstring or null
data[].customerTypeone of b2c, b2b
data[].productIdsarray of string
data[].priceIdsarray of string
data[].estimatedValuemoney
data[].sourceone of checkout, api
data[].statusone of pending, confirmed
data[].consentobject
data[].consent.textstring
data[].consent.textVersionstring
data[].consent.atdate-time
data[].confirmedAtdate-time or null
data[].checkoutSessionIdcs_… ID or null
data[].regimeIdstring or null
data[].blockedReasonone of evidence_conflict, unsupported_tax_category, registration_required, rate_unavailable, jurisdiction_blocked, tax_id_unavailable or null
data[].notifiedAtdate-time or null
data[].unsubscribedAtdate-time or nullWhen the customer left the waitlist (the link in its emails); never notified after that.
data[].createdAtdate-time
has_moreboolean
next_cursorstring or null

Examples

Confirmed entries for the UK

HTTP
GET /api/v1/waitlist_entries?country=GB&status=confirmed
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "data": [
    {
      "id": "wl_01m4tx5nj8emwbyf7y9vcf48ah",
      "object": "waitlist_entry",
      "livemode": false,
      "entityId": "ent_01m4tx5nj8emwbyf7y9vcf47x2",
      "brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
      "email": "oliver@example.com",
      "country": "GB",
      "subdivision": null,
      "customerType": "b2c",
      "productIds": ["prod_01m4tx5nj8emwbyf7y9vcf48ae"],
      "priceIds": ["price_01m4tx5nj8emwbyf7y9vcf48ad"],
      "estimatedValue": {
        "amount": "100000000",
        "currency": "EUR"
      },
      "source": "checkout",
      "status": "confirmed",
      "consent": {
        "text": "Notify me when Genno can sell in United Kingdom",
        "textVersion": "2026-10-14",
        "at": "2026-10-14T10:00:00.000Z"
      },
      "confirmedAt": "2026-10-14T10:12:00.000Z",
      "checkoutSessionId": "cs_01m4tx5nj8emwbyf7y9vcf48aa",
      "regimeId": null,
      "blockedReason": "registration_required",
      "notifiedAt": null,
      "unsubscribedAt": null,
      "createdAt": "2026-10-14T10:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors

CodeHTTP statusWhenWhat to do
validation_failed400A filter is malformed (param names it).Fix the fields listed in details.issues and send the request again.

It can also return these common errors: api_version_unsupported, authentication_required, api_key_invalid, permission_denied, scope_required, resource_not_found, dry_run_not_supported, rate_limited, internal_error.