Getting Started
FAQ & Troubleshooting
Find answers to common questions and troubleshooting tips for using the Captain Data API, including error handling, best practices, and debugging guidance.
Troubleshooting Errors
The API uses a consistent error response format across all endpoints. When an error occurs, you’ll receive a response with the following structure:
Each error response includes:
error_label
: A machine-readable identifier for the error typeerror_scope
: Indicates which part of the request caused the error (e.g., “input”, “auth”, “server”)error_ref
: A unique reference code for tracking and debuggingmessage
: A human-readable description of the errorstatus_code
: The HTTP status codeparams
: Additional error parameters (if any)
Common HTTP status codes:
200
: The request was successful (some API calls may return 201 instead)400
: Bad Request - Invalid input or parameters401
: Unauthorized - Invalid or missing API key403
: Forbidden - Insufficient permissions404
: Not Found - Resource doesn’t exist500
: Internal Server Error - Server-side issue
Always check the error_label
and error_scope
fields to programmatically
handle different types of errors in your application.
If you encounter an unusual error, such as a 500 or 503, feel free to reach out! These are internal errors on our end, and we’re happy to help resolve them.