Onboardbase uses conventional HTTP response codes to indicate the outcome of an API request. Generally, codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed due to the information provided (e.g., a wrong API Key header was passed to a request, a parameter was omitted failed, etc.). Codes in the 5xx range indicate an error with Onboardbase servers, these cases are rare.
HTTP Status Code Summary
Status Code | Message |
|---|---|
200 - OK | Everything worked as expected. |
400 - Bad Request | The request was unacceptable, often due to missing a required or invalid parameter. |
401 - Unauthorized | No valid API key provided. |
402 - Request Failed | The parameters were valid but the request failed. |
403 - Forbidden | The API key doesn't have permissions to perform the request. |
404 - Not Found | The requested resource doesn't exist. |
409 - Conflict | The request conflicts with another request |
429 - Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
500, 502, 503, 504 - Server Errors | Something went wrong on Onboardbase's end. (These are rare.) |