List available inventory for a variant

cURL

curl --location 'https://www.headout.com/api/public/v1/inventory/list-by/variant/?variantId=2671&offset=0&limit=150&currencyCode=AED' \
--header 'Headout-Auth: <YOUR_API_KEY>'

const options = {method: 'GET', headers: {'Headout-Auth': '<api-key>'}};

fetch('https://www.headout.com/api/public/v1/inventory/list-by/variant/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.headout.com/api/public/v1/inventory/list-by/variant/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Headout-Auth: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.headout.com/api/public/v1/inventory/list-by/variant/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Headout-Auth", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.headout.com/api/public/v1/inventory/list-by/variant/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Headout-Auth"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "486135052",
      "startDateTime": "2026-03-25T09:00:00",
      "endDateTime": "2026-03-25T22:00:00",
      "availability": "LIMITED",
      "remaining": 27,
      "pricing": {
        "persons": [
          {
            "type": "ADULT",
            "name": "Adult",
            "description": null,
            "ageFrom": 13,
            "ageTo": 61,
            "price": 54.44,
            "originalPrice": 54.44,
            "netPrice": 54.44,
            "headoutSellingPrice": 54.44,
            "remaining": 27,
            "availability": "LIMITED",
            "paxRange": {
              "min": null,
              "max": null
            }
          },
          {
            "type": "CHILD",
            "name": "Child",
            "description": null,
            "ageFrom": 6,
            "ageTo": 12,
            "price": 49,
            "originalPrice": 49,
            "netPrice": 49,
            "headoutSellingPrice": 49,
            "remaining": 27,
            "availability": "LIMITED",
            "paxRange": {
              "min": null,
              "max": null
            }
          },
          {
            "type": "SENIOR",
            "name": "Senior",
            "description": null,
            "ageFrom": 62,
            "ageTo": null,
            "price": 52.26,
            "originalPrice": 52.26,
            "netPrice": 52.26,
            "headoutSellingPrice": 52.26,
            "remaining": 27,
            "availability": "LIMITED",
            "paxRange": {
              "min": null,
              "max": null
            }
          }
        ],
        "groups": []
      }
    }
  ],
  "nextUrl": "https://www.headout.com/api/public/v1/inventory/list-by/variant?variantId=38164&currencyCode=USD&offset=1&limit=1",
  "prevUrl": null,
  "total": 12608,
  "nextOffset": 1
}

GET

api

public

inventory

list-by

variant

cURL

curl --location 'https://www.headout.com/api/public/v1/inventory/list-by/variant/?variantId=2671&offset=0&limit=150&currencyCode=AED' \
--header 'Headout-Auth: <YOUR_API_KEY>'

const options = {method: 'GET', headers: {'Headout-Auth': '<api-key>'}};

fetch('https://www.headout.com/api/public/v1/inventory/list-by/variant/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.headout.com/api/public/v1/inventory/list-by/variant/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Headout-Auth: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.headout.com/api/public/v1/inventory/list-by/variant/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Headout-Auth", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.headout.com/api/public/v1/inventory/list-by/variant/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Headout-Auth"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "486135052",
      "startDateTime": "2026-03-25T09:00:00",
      "endDateTime": "2026-03-25T22:00:00",
      "availability": "LIMITED",
      "remaining": 27,
      "pricing": {
        "persons": [
          {
            "type": "ADULT",
            "name": "Adult",
            "description": null,
            "ageFrom": 13,
            "ageTo": 61,
            "price": 54.44,
            "originalPrice": 54.44,
            "netPrice": 54.44,
            "headoutSellingPrice": 54.44,
            "remaining": 27,
            "availability": "LIMITED",
            "paxRange": {
              "min": null,
              "max": null
            }
          },
          {
            "type": "CHILD",
            "name": "Child",
            "description": null,
            "ageFrom": 6,
            "ageTo": 12,
            "price": 49,
            "originalPrice": 49,
            "netPrice": 49,
            "headoutSellingPrice": 49,
            "remaining": 27,
            "availability": "LIMITED",
            "paxRange": {
              "min": null,
              "max": null
            }
          },
          {
            "type": "SENIOR",
            "name": "Senior",
            "description": null,
            "ageFrom": 62,
            "ageTo": null,
            "price": 52.26,
            "originalPrice": 52.26,
            "netPrice": 52.26,
            "headoutSellingPrice": 52.26,
            "remaining": 27,
            "availability": "LIMITED",
            "paxRange": {
              "min": null,
              "max": null
            }
          }
        ],
        "groups": []
      }
    }
  ],
  "nextUrl": "https://www.headout.com/api/public/v1/inventory/list-by/variant?variantId=38164&currencyCode=USD&offset=1&limit=1",
  "prevUrl": null,
  "total": 12608,
  "nextOffset": 1
}

Authorizations

Headout-Auth

string

header

required

Query Parameters

variantId

string

required

ID of the variant to list inventory for.

startDateTime

string<date-time>

Start of the date range to fetch inventory for (format: yyyy-MM-dd'T'HH:mm:ss). Defaults to the current timestamp if not provided.

endDateTime

string<date-time>

End of the date range to fetch inventory for (format: yyyy-MM-dd'T'HH:mm:ss). Defaults to no end limit (returns all future slots) if not provided.

offset

integer

default:0

Number of items to skip before starting to collect the result set.

limit

integer

default:10

Maximum number of items to return.

currencyCode

string

Currency code for inventory pricing.

Response

200 - application/json

Successful response

items

object[]

The inventory slots in this page of results.

Show child attributes

nextUrl

string | null

Full URL to fetch the next page of results. Null if on the last page.

prevUrl

string | null

Full URL to fetch the previous page of results. Null if on the first page.

total

integer

Total number of available inventory slots across all pages.

nextOffset

integer | null

Offset value to use in the next request to retrieve the following page.

Guide

Cities

Categories

Products

Inventory

Bookings

List available inventory for a variant

Authorizations

Query Parameters

Response