Public
Documentation Settings

Uplisting API [Public]

The Uplisting API

Responses

401 Unauthorised

If the API key is not recognised in any API calls, the response will be 401 Unauthorised

200 OK

For GET endpoints: If the request body is formatted correctly, the response will be a 200 OK.

201 Created

For most POST endpoints, the response will be 201 with the ID of the entity created

202 Accepted

For the calendar update endpoint: If the request body is formatted correctly, the response will be a 202 Accepted. Along with a request ID as a JSON response.

Rate limiting

The API is designed to provide a list of bookings/availability as a "snapshot" and then webhooks should be used to get up-to-date information on changes in the system.

All calls to the Uplisting API are subject to rate limiting. If a partner exceeds the rate limits, a 429 Too Many Requests response is returned. We recommend to stagger requests througout a longer time frame to avoid hitting 429s.

We allow up to 5 requests per second per IP address and no more than 100 requests per minute per IP address and no more than 15 requests per min per property.

Loading