Get an organization's public waitlist configuration
Public, rate limited per IP.
GET/api/v1/beta/config
- Sign-in
- None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
- Rate limit
- Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 30 requests a minute per IP address.
Public, rate limited per IP. Answers only the fields the waitlist page draws and whether approving an entry sends an email, never the email templates; 404 when the organization has no waitlist configuration.
Request
Query parameters
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
orgId | string | Yes | format tenantKey | - |
Example request
Replace each YOUR_... value with your own.
curl -X GET "https://api.console.buildbase.app/api/v1/beta/config?orgId=YOUR_ORG_ID"const response = await fetch(
'https://api.console.buildbase.app/api/v1/beta/config?orgId=YOUR_ORG_ID',
{
method: 'GET',
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();import requests
response = requests.get(
"https://api.console.buildbase.app/api/v1/beta/config?orgId=YOUR_ORG_ID",
timeout=30,
)
response.raise_for_status()
data = response.json()Responses
200 OK
OK
{
"approvalEmail": true,
"description": "Signup for beta access to the application",
"enabled": true,
"logoFallBack": "",
"name": "Beta Users",
"privacyPolicy": "",
"screen": {
"register": {
"description": "Register with your email for beta access",
"title": "Register to Beta Users"
},
"thankYou": {
"description": "You have successfully registered for beta access.",
"title": "Thank You for Registering"
}
},
"termsOfService": ""
}Any other status
Any other answer the handler sends itself (its own refusals). Not described yet.
Errors
Each refusal, what it means, and what to do. The request changed nothing.
400 Bad Request
What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.
What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.
{
"error": true,
"success": false,
"path": "string",
"message": "string"
}404 Not Found
What it means: An id in the path names nothing in this org.
What to do: Check the ids in the path: one of them names nothing in this organization.
{
"success": false,
"message": "string"
}429 Too Many Requests
What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.
What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Related
- All Beta operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
beta.config.listin public-v1.json