Skip to main content
GET
Retrieve entry

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

id
string
required

The unique identifier of the waitlist entry to retrieve.

Example:

"entry_xxxxxxxxxxxx"

Response

A successful response

An entry represents a user's signup for a waitlisted plan.

created_at
string<date-time> | null
required

The datetime the entry was created.

Example:

"2023-12-01T05:00:00.401Z"

custom_field_responses
object[] | null
required

The list of responses collected from the user when submitting their waitlist entry.

id
string
required

The unique identifier for the entry.

Example:

"entry_xxxxxxxxxxxx"

plan
object | null
required

The waitlisted plan that this entry is a signup for.

product
object | null
required

The product associated with this entry's waitlisted plan. Null if the plan is not tied to a product.

status
enum<string>
required

The current status of the waitlist entry (e.g., drafted, pending, approved, denied).

Available options:
drafted,
pending,
approved,
denied,
any
user
object
required

The user who submitted this waitlist entry.