Errors
HTTP status codes
API requests may not always succeed. Reasons for failure can vary. In each case, the API will return an HTTP response status code that indicates the cause of the failure, along with a JSON formatted response body containing additional details.
Examples
Authorization header is not present
GET https://api.fireberry.com/api/record/account/{id} HTTP/1.1
HTTP/1.1 401 Unauthorized
Bad request parameters
GET https://api.fireberry.com/api/record HTTP/1.1
"tokenid: APITOKENID"
HTTP/1.1 400 Bad Request
{
"Message": "An internal error has occured while processing your request. Please check your data"
}
Fireberry encountered an issue
GET https://api.fireberry.com/api/record/account/{id} HTTP/1.1
"tokenid: APITOKENID"
HTTP/1.1 500 Server Error
{
"Message": "An internal error has occured while processing your request. Please check your data"
}
Types of errors
| Code | Meaning | Description |
|---|---|---|
200 | Success | If data was requested, it can be found in the data field at the top level of the response body. |
201 | Created | Information about it can be found in the data field at the top level of the response body. Additionally, the API URL where the object can be accessed is included in the Location header of the response. |
400 | Bad Request | This is often caused by a missing or incorrectly formatted parameter. Review the documentation and the format of your request, and then try again. |
401 | Unauthorized | The request could not be associated with a user because a valid authentication token was not provided. |
402 | Payment Required | The request is valid, but the specified object or action in the request is not accessible to your plan. |
403 | Forbidden | The authentication and request syntax were valid, but the server is denying to fulfill the request. This can occur when attempting to access or modify objects or properties that the user does not have permission to. |
404 | Not Found | The request method and token supplied do not match a recognized action in the API, or the object specified in the request does not exist. |
408 | Timeout | The request did not meet the reasonable time limit of 30 seconds. Please simplify your request and try again. |
429 | Too Many Requests | You have surpassed one of the established rate limits in the API. Please refer to the documentation on rate limits for further information. |
500 | Server Error | There was a problem on Fireberry's server. |
408 Error
In the case of a 408 error, try to simplify the request by reducing filters, decreasing the number of fields, etc., so that the request can complete within a reasonable time. If it still continues, please contact our support team.
403 Error
In the case of a 403 error, the user does not have permission to access the data.
Check the user's role permissions and if necessary, grant them the required permissions.
Updated 8 months ago