users_waitlist_get

Tool

users_waitlist_get

Read ONE waitlist entry by user id — its funnel status, the address it joined with, where the signup came from (referrer/UTM), the consent proof recorded for it, and the timestamp of every stage it passed. The same shape users_waitlist_list returns per row. A user who is not on this product's waitlist answers 404.

Behavior

HTTP: POST /users/waitlist/get

Arguments

Name	Type	Required	Description
userId	string	•	The waitlisted user to read — the `userId` from `users_waitlist_list`.

Response

Field	Type	Always	Description
status	string	•	Where in the funnel this entry is: `pending`, `invited`, `registered` or `withdrawn`.
userId	string	•	The waitlisted user. Every users_users_* tool takes this id.
createdAt	string	•	When the entry joined the waitlist (ISO 8601).
invitedAt	string	•	When the invite was sent (ISO 8601). Null while the entry is pending.
identifier	string	•	The email address that signed up.
attribution	object	•	Where the signup came from — the campaign, referrer and landing page recorded at the time.
confirmedAt	string	•	When the address confirmed a double opt-in (ISO 8601). Null when it never did.
withdrawnAt	string	•	When the address asked to be taken off the list (ISO 8601). Null when it did not.
consentProof	object	•	What was recorded to show this address consented: when, from where, and under which wording.
registeredAt	string	•	When the invitee finished signing up (ISO 8601). Null until they do.
inviteTokenId	string	•	Id of the live invite token. Null while the entry has not been invited.

Try it

Read ONE waitlist entry by user id — its funnel status, the address it joined with, where the signup came from (referrer/UTM), the consent proof recorded for it, and the timestamp of every stage it passed.

When to use

Example

Ask your agent something like this:

Read ONE waitlist entry by user id — its funnel status, the address it joined with, where the signup came from (referrer/UTM), the consent proof recorded for it, and the timestamp of every stage it passed.

The agent will invoke users_waitlist_get with these arguments:

{
  "userId": "<userId>"
}