Codat · Schema

Error message

Unified-API

Properties

Name Type Description
statusCode integer The HTTP status code returned by the error.
service string Codat's service the returned the error.
error string A brief description of the error.
correlationId string Unique identifier used to propagate to all downstream services and determine the source of the error.
validation object
canBeRetried string `True` if the error occurred transiently and can be retried.
detailedErrorCode integer Machine readable error code used to automate processes based on the code returned.
View JSON Schema on GitHub

JSON Schema

codat-errormessage-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ErrorMessage",
  "title": "Error message",
  "type": "object",
  "x-internal": true,
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "The HTTP status code returned by the error."
    },
    "service": {
      "type": "string",
      "description": "Codat's service the returned the error."
    },
    "error": {
      "type": "string",
      "description": "A brief description of the error."
    },
    "correlationId": {
      "type": "string",
      "description": "Unique identifier used to propagate to all downstream services and determine the source of the error."
    },
    "validation": {
      "$ref": "#/components/schemas/ErrorMessage/definitions/errorValidation"
    },
    "canBeRetried": {
      "type": "string",
      "description": "`True` if the error occurred transiently and can be retried."
    },
    "detailedErrorCode": {
      "type": "integer",
      "description": "Machine readable error code used to automate processes based on the code returned."
    }
  },
  "definitions": {
    "errorValidation": {
      "title": "Validation error",
      "type": "object",
      "nullable": true,
      "description": "A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.",
      "properties": {
        "errors": {
          "type": "array",
          "nullable": true,
          "items": {
            "$ref": "#/components/schemas/ErrorMessage/definitions/errorValidationItem"
          }
        },
        "warnings": {
          "type": "array",
          "nullable": true,
          "items": {
            "$ref": "#/components/schemas/ErrorMessage/definitions/errorValidationItem"
          }
        }
      }
    },
    "errorValidationItem": {
      "title": "Validation error item",
      "type": "object",
      "properties": {
        "itemId": {
          "type": "string",
          "nullable": true,
          "description": "Unique identifier for a validation item."
        },
        "message": {
          "type": "string",
          "nullable": true,
          "description": "A message outlining validation item's issue."
        },
        "validatorName": {
          "type": "string",
          "nullable": true,
          "description": "Name of validator."
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/codat-errormessage"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.