Skip to main content
GET
List Waitlist Entries

Autorisaties

Authorization
string
header
vereist

An Account API key, an App API key, an account access token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

waitlist_entry:read
plan:waitlist:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Queryparameters

first
integer
standaard:20

Number of results to return from the start of the range.

Vereist bereik: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Vereist bereik: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

variant_id
string

Only return signups for this variant, prefixed plan_.

account_id
string

Only return signups submitted to this seller account, prefixed biz_.

product_id
string

Only return signups for variants on this product, prefixed prod_.

buyer_account_id
string

List the signups submitted on behalf of this account, prefixed biz_, instead of your own and seller signups. Requires waitlist_entry:read on the account. The other filters still apply.

status
enum<string>

Only return signups in this state. Canceled signups are returned only when status is canceled.

Beschikbare opties:
pending,
approved,
denied,
canceled
query
string

Search signups by the user's name or username, or the name of the account they were submitted on behalf of. An account ID, prefixed biz_, matches signups submitted on behalf of that account, and a user ID, prefixed user_, or an exact email address matches that user's signups.

created_before
string<date_time>

Only return signups submitted at or before this ISO 8601 timestamp.

created_after
string<date_time>

Only return signups submitted at or after this ISO 8601 timestamp.

order
enum<string>

The field to sort results by. Defaults to created_at.

Beschikbare opties:
created_at
direction
enum<string>

The sort direction for results. Defaults to descending.

Beschikbare opties:
asc,
desc

Respons

own signups only

data
object[]
vereist
page_info
object
vereist