Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HeadOut Subcategories API

The Subcategories API from HeadOut — 1 operation(s) for subcategories.

HeadOut Subcategories API is one of 6 APIs that HeadOut publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subcategories. 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.

1 operations 1 paths 4 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://www.headout.com/api/public/v2
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

HeadOut Subcategories 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.

Subcategories 1
GET
/api/public/v2/subcategories
List subcategories for a city
listSubcategories 4 params → 200400

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Pagination (4 properties), Subcategory (4 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Subcategory
object
4 properties
SubcategoryPage
Pagination
object
4 properties
Error
object
Headout error envelope.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

headout-subcategories-api-openapi.yml Raw ↑

Other APIs HeadOut publishes across the network.

HeadOut Booking API
HeadOut Categories API
HeadOut Collections API
HeadOut Inventory API
HeadOut Products API