Skip to main content
Welcome to the HaltH API documentation. The HaltH API is a REST API offering JSON over HTTP request and response types.

​
Server

All of the HaltH API resources are accessible on https://api.halth.com

​
Authentication

​
Bearer Authentication

Authentication for API access is achieved via Bearer Authentication. Include your JWT in the request header using the format: Authorization: Bearer your_jwt.

​
Secure Communication

All API requests must be conducted over HTTPS. Requests made over plain HTTP will not succeed. Additionally, unauthenticated API requests will result in failure.

​
Timezones

All datetime values provided in request parameters and responses are in Coordinated Universal Time (UTC) following the ISO 8601 format. All dates i.e. no time included, are assumed to be in the resource’s local time e.g. date of birth.

​
Currency

All monetary values are represented in the smallest unit of the respective currency (e.g., cents for AUD or USD). If a currency is not explicitly specified, the system will default to the local currency of the associated organisation.

​
Paging

All list endpoints will return a paged response matching the below JSON structure. You may iterate the pages by altering the page query paramter in your request. You may adjust the number of items returned by altering the limit query parameter in your request (up to a maximum of 200). 
{
    "items": [],
    "page": 1,
    "limit": 10,
    "totalItems": 0,
    "totalPages": 1
}

​
Expanding Responses

Many objects allow you to request additional information as an expanded response by using the expand request parameter. For example a booking container several fields such as cancellationPolicy. By default, this field will not be included, however, you may request it by listing the field name in the expand array. You can expand multiple objects at the same time by sending multiple items in the expand array.

​
Query Parameters

All query parameters will be received as strings, validated, and converted to their expected type. Array parameters may be included multiple times e.g. expand=a&expand=b&expand=c. Other formats will not be accepted. When using Axios, set the following config: 
paramsSerializer: {
    indexes: null
}