Error Handling

The API uses standard HTTP status codes and consistent error response formats to help you handle errors effectively.

Standard Error Codes

Error Response Format

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ]
  }
}

Troubleshooting Common Issues

Authentication Errors

Verify your API credentials and check if your access token has expired. Tokens expire after 1 hour and need to be refreshed.

Validation Errors

When receiving a 422 status code:

• Check your request payload against the API specifications
• Review the error details array for specific field validation failures
• Ensure all required fields are provided
• Verify data types and formats match the API requirements

Rate Limiting

If you receive a 429 status code:

• Implement exponential backoff in your retry logic
• Consider reducing your request frequency
• Check your rate limits in the API response headers

Resource Not Found

When receiving a 404 status code:

• Verify the resource ID exists and is correct
• Check if you're using the correct API endpoint
• Ensure the resource hasn't been deleted

Server Errors

For 500 or 502 status codes:

• Note the timestamp of the error
• Save the request details and error response
• Contact support with this information for assistance