List the API error codes

Every error code the API emits, with the status it carries, whether repeating the request can succeed, what happened, and what to do about it.

This is the registry behind the docsUrl on every error body. It is account-free and served from a compiled constant, so it stays available while the dependency that caused your error is still failing. Pass ?code= to resolve a single entry.

GET /errors

List the API error codes

cURL

curl --request GET \
  --url https://useorgx.com/api/v1/errors

200

{
  "data": {
    "version": "1",
    "docs_url_template": "https://docs.useorgx.com/api/errors/{code}",
    "envelope": {
      "error": {
        "code": "The registry code. Stable; safe to branch on.",
        "message": "A curated sentence. Human-facing; never branch on it.",
        "requestId": "Correlates this response with the server log line."
      }
    },
    "errors": [
      {
        "code": "not_found",
        "status": 404,
        "retryable": false,
        "title": "No resource is reachable at that id.",
        "remedy": "Confirm the id and that your credential reaches its workspace. Unknown and out-of-scope ids return the same 404."
      },
      {
        "code": "rate_limited",
        "status": 429,
        "retryable": true,
        "title": "The credential exceeded its rate class for this window.",
        "remedy": "Wait `Retry-After` seconds. Budgets are per credential and per class, not per route."
      }
    ]
  },
  "meta": {
    "apiVersion": "1",
    "count": 218
  }
}

Headers

If-None-Match · string

Prior ETag. A match answers 304.

Query Parameters

code · string

Resolve one code instead of listing the registry.

Response

200

application/json

The error-code registry

data · object · required

Show child attributes

meta · object · required

Show child attributes