Responses

The structure of a response alongside its HTTP status code can be seen alongside each API method. In this API, we use conventional HTTP status codes to signal the success or failure of an API request.

HTTP Status Codes

Success (2xx)

  • 200 OK: Request succeeded, data returned.

  • 201 Created: Request fulfilled, new resource created.

  • 204 No Content: Request processed, no data to return.

Client Error (4xx)

  • 400 Bad Request: Malformed or invalid request.

  • 401 Unauthorized: Authentication required, invalid credentials.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: Resource not found.

  • 422 Unprocessable Entity: Well-formed request, semantic errors.

Server Error (5xx)

  • 500 Internal Server Error: Server-side error.

  • 503 Service Unavailable: Server unable to handle request (maintenance/overload).

Last updated