Introduction
The Hayylo API allows customers to access key data elements from their account. Access is limited to customers who have purchased the API module as part of their overall Hayylo license.
Access
All licensed customers will receive their credentials from their account manager or the Hayylo support team. The API credentials consist of keys which must be provided as HTTP headers in all API requests.
Usage
All customer API accounts are limited in usage. Limits apply to requests per second and overall requests per month. For more information about these limits please speak to your Hayylo account manager or contact Hayylo support.
Request format
-
All API requests use HTTP GET methods
-
Resource API requests expect an identifier (GUID) provided as a path parameter
-
Search API requests expect search parameters provided as query string parameters
Response format
-
All API responses return JSON payloads
-
API resource responses return a single object
-
API search responses return an array of objects
Pagination
Search API endpoints will return a single page of 100 results as a default. Larger pages can be provided by providing a larger value with the page_size query parameter. The offset query parameter allows you to return subsequent pages of results.
Dates
All dates unless otherwise indicated are stored internally in Hayylo in UTC as timestamps. The Hayylo API currently returns all dates in UTC in simplified extended ISO format. Eg: YYYY-MM-DDTHH:mm:ss.sssZ.
Unless otherwise indicated, any dates that are accepted as Search API parameters can be provided as just a date (eg, YYYY-MM-DD) or as an ISO timestamp in the format described above.
API Reference
The API reference for each endpoint is available on SwaggerHub via the links below.