HTTP Responses

HTTP Status Codes

The Hospitable Public API returns HTTP Status Codes with every response, including error codes. All being well, you should expect to see status codes in the 200 range alongside your responses.

In the event of a problem, the status code is a reliable indicator of what went wrong. Return codes in the 400 range indicate that there was an issue with the request that was sent. Status codes in the 500 range may mean that either we or a provider (e.g. Airbnb or HomeAway/VRBO) are experiencing an issue - check our Status Page for more information on that.

Response Body Format

The Hospitable API responds in JSON format adhering to the following JSON Schema:

{
  'data': [
    {
      '_included': [
        {
          'rel': 'string',
          'data': {}
        }
      ],
      '_meta': {
        'rel': 'string',
        'version': 'string',
        'warnings': 'string'
      }
    }
  ],
  'pagination': {}
}

A further explanation of this schema:

  • data: The requested data, either as an entity or array of entities (if multiple were requested).
  • _included: Any included resources added onto the request. See docs on Includes.
  • _meta: Further information alongside the request, possibly including links to other resources, or any warnings (e.g. if a deprecated version of the resource was requested).
  • _pagination: Information on the number of pages available, if the request was paginated. See pagination docs.

Unique request ID

Every response from the Public API contains an X-hospitable-trace header which provides the unique ID given to the request:

X-hospitable-trace: 'b4bc88fd9b8446768bde07864e6ee263'