​
Overview

When an API request fails, the response will contain details about what went wrong. All error responses follow a consistent format to help you debug and handle errors appropriately.

​
Error Response Structure

{
  "message": "A human-readable error message",
  "code": "error_code",
  "details": [
    {
      "idempotencyKey": "82dc795a-8293-4c21-b1e6-f48cb19bd5b9",
      "errors": [
        {
          "code": "future_occurred_at",
          "message": "events occurring in the future cannot be recorded"
        }
      ]
    }
  ],
  "causations": [
    {
      "message": "Underlying error cause",
      "code": "cause_code",
      "details": {}
    }
  ]
}
FieldTypeDescription
messagestringA human-readable description of the error
codestringA unique identifier for the type of error
detailsobject or arrayAdditional context about the error, such as invalid fields or constraints. Each endpoint may include specific error details in their documentation
causationsarray of errorOptional array of error objects following the same structure as the parent error. Only present when there’s a meaningful chain of related errors to expose

​
HTTP Status Codes

NameStatus CodeDescription
Bad Request400The request was malformed or contains invalid parameters.
Unauthorized401Authentication is required or the provided credentials are invalid.
Forbidden403The authenticated user doesn’t have permission to access the requested resource.
Not Found404The requested resource doesn’t exist.
Internal Server Error500Something went wrong on our end.