HorizonIQ Support API
Endpoints related to support cases
HorizonIQ Support API is one of 9 APIs that HorizonIQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Support. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 9 operations across 5 paths, and defines 18 schemas. It is described by OpenAPI 3.0.1, at version 2023-05-30T22:28:43Z.
Requests are made against a single base URL, https://api.compass.horizoniq.com/{basePath}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HorizonIQ Support API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— API token issued from the Compass portal (Profile API Tokens). Sent as Authorization: Bearer . See https://compass-horizoniq.readme.io/reference/authentication
Paths & Operations 9
Across 5 paths, the API surfaces 9 operations — 5 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Endpoints related to support cases
Schemas 18
The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are SupportCaseGetModel (28 properties), SupportLocationGetModel (12 properties), SupportCaseCommentGetModel (7 properties), SupportCaseListModel (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HorizonIQ 8
Other APIs HorizonIQ publishes across the network.