Docs

Overview

Understand API status codes and response formats.

The response structure depends on whether your request succeeds or returns an error.

Responses Status Codes Overview

The following table explains the response status codes.

Status Code Description
200OK When retrieving a resource
201 Created When creating a new resource
204 No Content Updating or deleting a resource
400 Bad Request Invalid request parameters, validation errors, or malformed request body
401 Unauthorized Authentication error: Invalid credentials or subscription inactive
403 Forbidden Insufficient permission to access the resource
404 Not Found The requested resource doesn't exist
429 Too Many Requests Rate limit exceeded - too many requests in a given time period
500 Internal Server Error Unexpected internal error - please try again later

See Success responses and Error responses for their schemas and examples.