Error Responses in the Data API - Data API

The Data API returns errors in the RFC 7807 format (application/problem+json). Every error response includes a consistent set of fields so you can programmatically detect the problem, log the details, and decide how to retry or correct the request.

Problem JSON Format

Every error response body contains these fields:

Field	Type	Description
`type`	string	A URI that identifies the error type. Defaults to `about:blank` for generic errors.
`title`	string	A short, human-readable summary of the error type.
`status`	integer	The HTTP status code.
`detail`	string	A detailed, human-readable explanation of this specific occurrence.
`instance`	string	The request path that produced the error.

Example error response for an invalid API key:

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "Invalid API key",
  "instance": "/v1/property/properties"
}

Status Codes

Status	Meaning	What to do
400	Missing required filter	Check the endpoint documentation for required query parameters and add them to the request.
401	Missing API key	Send the `X-API-Key` header with every request.
403	Key rejected or access tier missing	The key is unknown or disabled, or it has no permission for this endpoint or table, or it is restricted to properties and the table has no `property_id` column. Check the `detail` field. Contact Trassets support to change your access tier.
404	Unknown endpoint	Verify the URL path and the category or table name.
409	Snapshot changed	The table was re-synced while you paginated. Restart from the first page without `cursor`. See Pagination.
422	Validation error	A query parameter did not pass validation. Check the `detail` field for the exact parameter and constraint.
429	Rate limit exceeded	You have exceeded the 2,500 requests per hour limit of your API key. Back off and retry after the current window resets.
500	Internal error	A server-side error occurred. Retry the request after a short delay, and contact support if it persists.

A 401 only means the X-API-Key header is missing. An unknown or disabled key returns 403, as does a valid key that lacks the required access tier. Read the detail field to tell them apart.