Error

What went wrong, and which part of the request caused it.

  • details
    Type: array object[] · ErrorDetail[]
    required

    One entry per individual problem, so a rejected request can be fixed in one pass instead of one field at a time. Empty on failures that are not field-specific.

    A single problem with the request, pointing at the parameter or body field responsible.

    • code
      Type: string enum
      required

      Machine-readable reason this field was rejected:

      • blank — a required value was empty or missing.
      • invalid_value — the value was the wrong shape, or outside the allowed set.
      • not_accessible — the value names a record that does not exist in your account, or that this token may not use.
      • parameter_missing — a required top-level wrapper was absent from the body.
      • unknown_filter — no such filter[...] key on this endpoint.
      • conflicting_filters — two filters were supplied that cannot be combined.
      • unknown_sort_field — no such sortable field on this endpoint.
      • internal_error — the failure could not be attributed to the request.
      values
      • blank
      • invalid_value
      • not_accessible
      • parameter_missing
      • unknown_filter
      • conflicting_filters
      • unknown_sort_field
      • internal_error
    • message
      Type: string
      required

      Human-readable description of this specific problem.

    • source
      required

      What the problem is about. Body problems carry a JSON pointer; query-string problems carry a parameter name. Exactly one of the two is present.

      What the problem is about. Body problems carry a JSON pointer; query-string problems carry a parameter name. Exactly one of the two is present.

      • pointer
        Type: string
        required

        JSON pointer to the offending field in the request body.

  • message
    Type: string
    required

    Human-readable summary of the failure. Intended for logs and developers, not for end users.

  • request_id
    Type: string
    required

    Identifier for the failed request. Quote it when contacting support.

  • status
    Type: integer
    required

    The HTTP status code, repeated here so the body is self-contained.

  • type
    Type: string enum
    required

    What kind of failure this is. Branch on this rather than on message:

    • bad_request (400) — a query parameter is unknown, malformed or conflicts with another.
    • authentication_error (401) — the access token is missing, expired or invalid.
    • insufficient_permissions (403) — the token is valid but the member behind it is not allowed to do this.
    • not_found (404) — no such record in your account.
    • validation_error (422) — the request body was understood but rejected. See details.
    • rate_limited (429) — you have exhausted a rate limit window.
    • internal_error (500) — something failed on our side. Safe to retry.
    values
    • bad_request
    • authentication_error
    • insufficient_permissions
    • not_found
    • validation_error
    • rate_limited
    • internal_error