Whereby REST API reference
We rate limit our APIs, returning a
429status code response when your request has been throttled. You will have to wait and retry the request later.
We use a point system to limit the number of requests that you can make. A read request consumes 1 point, a delete consumes 2 points and a write request consumes 3 points. Here are some examples of how a 1000 point budget could be spent within 1 minute:
- 1000 GET requests (1000 x 1 = 1000 points)
- 500 DELETE requests (500 x 2 = 1000 points)
- 333 POST requests (333 x 3 = 999 points)
- 200 DELETE + 100 POST + 300 GET requests (200 x 2 + 100 x 3 + 300 x 1 = 1000 points)
Grow plans have 1000 points in total per minute, and Build plans have 100. The limits are global and are shared across all your API keys. Talk to us if you need higher limits.
You may read the
X-RateLimit-Reset(date) response headers in order to know when you can restart your requests. In addition, the
X-RateLimit-Limitheader includes the total number of points for your organization, and the
X-RateLimit-Remainingheader displays the remaining available points.
The bearer token will be provided upon request and it is up to the client to keep it secret. Every API call needs to contain this token in order to authenticate and authorize the client.
Security Scheme Type
HTTP Authorization Scheme
Creates a transient room that is available between creation and an hour after the given
endDate. After this time the room will be automatically deleted. The URL to this room is present in the response.
Get room insights
Get room session insights
Set room logo
Set room colors
Set room background
Set room knock page background