Response codes
HTTP status
| Status | Meaning | What to do |
|---|---|---|
200 | Operation completed. | — |
400 | Wrong parameters, empty or invalid body, Content-Type other than application/json on management routes, or missing or malformed Authorization header. | Review the fields, headers and values sent. |
401 | Invalid or expired token, or credentials not accepted. | Obtain a new token from POST /oauth/token. |
403 | The operator lacks the required permission or access to the entity; in reports, also start/end missing or not integers; at sign-in, operator locked. | Check the permissions of the operator’s groups and the parameters. |
404 | Entity not found. | Check the identifier sent. |
415 | Content-Type other than application/x-www-form-urlencoded when issuing the token. | Send the credentials as a form. |
500 | Internal server error. | Try again; if it persists, contact support. |
Error format
API route errors follow this format:
{
"field": "instance",
"error": "instance error",
"error_description": "NAME is required"
}Authorization header validation errors (400 and 401) are returned as plain text, such as Unauthorized.
Responses with no records
Reports respond 200 with {"data": null, "next": ""} when there are no records for the given filters.
Message codes
Reports carry the message code in CODIGOMENSAGEM (for example, MSG0065 or MSG3100). It identifies the event recorded by the platform.