A valid request URL is required to generate request examples{
"waitlist": "<string>",
"entries": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123,
"name": "<string>",
"email": "jsmith@example.com",
"email_verified": true,
"metadata": {},
"source": "<string>",
"referrer": "<string>",
"joined_at": "2023-11-07T05:31:56Z",
"admitted_at": "2023-11-07T05:31:56Z"
}
],
"waiting": 123,
"admitted": 123,
"queues": [
{
"waitlist": "<string>",
"waiting": 123,
"admitted": 123,
"last_joined_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Read the waitlist
One feature queue for one environment, in joining order — that order is the position. waitlist names the queue; without it the answer carries only queues (every feature queue this environment has, with its counts) and an empty page, which is how a screen learns the names before it can ask for one. A feature queue never affects anybody’s ability to sign in.
A valid request URL is required to generate request examples{
"waitlist": "<string>",
"entries": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123,
"name": "<string>",
"email": "jsmith@example.com",
"email_verified": true,
"metadata": {},
"source": "<string>",
"referrer": "<string>",
"joined_at": "2023-11-07T05:31:56Z",
"admitted_at": "2023-11-07T05:31:56Z"
}
],
"waiting": 123,
"admitted": 123,
"queues": [
{
"waitlist": "<string>",
"waiting": 123,
"admitted": 123,
"last_joined_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Query Parameters
Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.
live, test Which feature queue — the list of people who asked for early access to one part of your product. Queues are never fused into one list: positions in one counted around another would tell somebody they are 40th in a queue of 12. On the read it may be left out, and the answer then carries only queues (every queue this environment has, with its counts) and an empty page — how a screen learns the names before it can ask for one. On the admit it is required.
^[a-z0-9][a-z0-9._-]{0,79}$Response
One queue, plus the feature queues this environment turned out to have.
Which queue this response is about — named rather than inferred, so a screen never has to work out which list it is holding. Empty when no queue was named, in which case entries is empty too.
Show child attributes
Show child attributes
Every feature queue this environment has, with its counts — derived from the entries, because a queue exists when somebody asked to be in it.
Show child attributes
Show child attributes