Links

Errors

Errors

Response types are mapped to HTTP status codes. In particular:
  • 200 OK — when data is successfully returned for a GET request
  • 201 Created — when new data is submitted to via a POST
  • 400 Bad Request — the submitted data is malformed
  • 401 Unauthorized — when the Authorization header is missing, if the value is invalid, or if the corresponding access token lacks the required scopes to complete the request
  • 404 Not Found — the URL is invalid, or the resource ID reference in the URL does not exist
  • 422 Unprocessable Entity — the submitted data is properly formatted, but invalid according to business logic (some legacy endpoints use 409 Conflict in this case)
  • 5xx — server error
Minor version changes to the API are guaranteed to be backwards compatible. Major version changes may break the API, but legacy versions are supported indefinitely.