Making too many requests to the SafetyCulture API
To ensure the stability and security of our servers requests sent to the API by the same user simultaneously at a high rate will be throttled. In that case the API will return a 429 HTTP status code with an error message Too Many Requests
.
Our rate limiting policy consists of a hard throttling limit
Endpoint | Rate | Interval |
---|---|---|
POST /users/search | 200 | 60 seconds |
GET /share/connections | 200 | 60 seconds |
POST /audits | 30 | 60 seconds |
GET /audits/search | 200 | 60 seconds |
GET /export_profiles/search | 200 | 60 seconds |
GET /templates/search | 200 | 60 seconds |
GET /response_sets | 200 | 60 seconds |
POST /audits/<audit ID>/export | 20 | 60 seconds |
GET /audits/<audit ID>/exports/<export ID> | 100 | 60 seconds |
GET /audits/<audit ID>/exports/<export ID>/<filename> | 100 | 60 seconds |
GET /preferences/search | 200 | 60 seconds |
POST /audits/{audit ID}/report | 200 | 60 seconds |
GET /audits/{audit ID}/report/{export ID} | 200 | 60 seconds |
Other | 800 | 60 seconds |
Rate limit response headers
All responses sent from the API will include headers which can be used to help manage the rate which requests are being sent to the API.
Header | Description |
---|---|
x-ratelimit-limit | The rate limit credit for that given endpoint |
x-ratelimit-remaining | The number of requests left for the window |
x-ratelimit-reset | The number of seconds until this window resets |