Error codes

Errors use the HTTP status code plus a JSON body. The last part of type is the code below, and detail says what went wrong in plain words.

{
  "type": "https://developer.orbytelgroup.com/errors/invalid_parameter",
  "title": "Bad Request",
  "status": 400,
  "detail": "\"year\" must be a whole number from 1900 to 2100.",
  "request_id": "3db3a78eb7aedbbe37742929e9daf451"
}

Quote the request_id if you contact us.

Code	Status	Meaning and fix
`missing_api_key`	401	No key was sent. Add `Authorization: Bearer <key>`.
`invalid_api_key`	401	The key isn't recognised. Check it was copied in full.
`revoked_api_key`	401	The key was revoked or replaced. Ask Orbytel Group for the current key.
`expired_api_key`	401	A trial or time-limited key has expired. Contact Orbytel Group to extend it.
`ip_not_allowed`	403	The key is restricted to certain IP addresses and this request came from another one.
`dataset_not_licensed`	403	Your license doesn't include this dataset.
`not_found`	404	No such endpoint. Check the path against the reference.
`record_not_found`	404	No record with that id in your license. It may have been removed; the change feed will say so.
`method_not_allowed`	405	The API is read-only. Use `GET`.
`invalid_parameter`	400	A parameter has the wrong form; `detail` names it and the expected format.
`unknown_parameter`	400	A parameter this endpoint doesn't take (often a typo). `detail` lists the ones it does.
`invalid_cursor`	400	The `cursor` isn't one this API gave out. Use `next_cursor` from the previous page.
`invalid_sync_token`	400	The `since` value isn't a sync token from this API. Use `next_sync_token`, or an export's `X-Sync-Token`.
`resync_required`	410	Your license changed after this token was issued. Reload `/exports/{dataset}` and continue from its token. See syncing.
`rate_limited`	429	Over your per-minute limit. Wait the number of seconds in `Retry-After`.
`server_error`	500	Something went wrong on our side. Retry later and quote the `request_id` if it persists.
`service_unavailable`	503	Temporarily unavailable. Retry after `Retry-After` seconds.