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 CodeMessage
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required or invalid parameter.
401 - UnauthorizedNo valid API key provided.
402 - Request FailedThe parameters were valid but the request failed.
403 - ForbiddenThe API key doesn't have permissions to perform the request.
404 - Not FoundThe requested resource doesn't exist.
409 - ConflictThe request conflicts with another request
429 - Too Many RequestsToo many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504 - Server ErrorsSomething went wrong on Onboardbase's end. (These are rare.)