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 Booking API

The Booking API from HeadOut — 2 operation(s) for booking.

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

Tagged areas include Booking. 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 4 operations across 2 paths, and defines 6 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.

4 operations 2 paths 6 schemas 2 GET1 POST1 PUT

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 Booking 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 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Booking 4
GET
/api/public/v1/booking
List bookings
listBookings 2 params → 200401
POST
/api/public/v1/booking
Create a booking (step 1)
createBooking body → 200400401
GET
/api/public/v1/booking/{id}
Retrieve a booking
getBooking 1 param → 200401404
PUT
/api/public/v1/booking/{id}
Capture / update a booking (step 2)
updateBooking 1 param body → 200400401404

Schemas 6

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

BookingPage
BookingCreateRequest
object
5 properties 3 required
Pagination
object
4 properties
BookingUpdateRequest
object
2 properties 1 required
Booking
object
5 properties
Error
object
Headout error envelope.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

headout-booking-api-openapi.yml Raw ↑

Other APIs HeadOut publishes across the network.

HeadOut Categories API
HeadOut Collections API
HeadOut Inventory API
HeadOut Products API
HeadOut Subcategories API