HeadOut Inventory API
The Inventory API from HeadOut — 1 operation(s) for inventory.
HeadOut Inventory API is one of 6 APIs that HeadOut publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Inventory. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.
This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 2.0.
Requests are made against 2 base URLs: https://www.headout.com, https://sandbox.api.test-headout.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HeadOut Inventory API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Headout-Auth (HeadoutAuth).
By default, every request must be authenticated.
HeadoutAuth— API token. Production keys are prefixed pk, testing keys tk.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Inventory (6 properties), Pagination (4 properties), Error (2 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 HeadOut 5
Other APIs HeadOut publishes across the network.