Get an add-on by ID

curl --request GET \
  --url https://api.opencals.com/storefront/add-ons/{addOnId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.opencals.com/storefront/add-ons/{addOnId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.opencals.com/storefront/add-ons/{addOnId}', 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://api.opencals.com/storefront/add-ons/{addOnId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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://api.opencals.com/storefront/add-ons/{addOnId}"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.opencals.com/storefront/add-ons/{addOnId}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opencals.com/storefront/add-ons/{addOnId}")

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

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

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "1234567890",
  "externalVariantId": "9876543210",
  "storeId": "123e4567-e89b-12d3-a456-426614174001",
  "slug": "child-seat",
  "title": "Child Seat",
  "description": "<string>",
  "imageId": "<string>",
  "color": "slate",
  "price": 15,
  "taxable": true,
  "durationMultiplied": false,
  "maxQuantity": 4,
  "status": "active",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "images": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "img_123456",
      "url": "https://storage.example.com/images/product-image.jpg",
      "filename": "product-image.jpg",
      "mime": "image/jpeg",
      "createdAt": "2023-01-01T12:00:00Z",
      "updatedAt": "2023-01-02T12:00:00Z",
      "deletedAt": "2023-01-03T12:00:00Z",
      "storeId": "store-uuid"
    }
  ],
  "locations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "storeId": "123e4567-e89b-12d3-a456-426614174001",
      "scheduleId": "123e4567-e89b-12d3-a456-426614174002",
      "title": "Main Office",
      "description": "Our main downtown office location with 3 treatment rooms",
      "slug": "new-york",
      "type": "physical",
      "link": "https://zoom.us/j/123456789",
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 200",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94105",
      "country": "United States",
      "addressPlaceId": "ChIJIQBpAG2ahYAR_6128GcTUEo",
      "latitude": 37.4224764,
      "longitude": -122.0842499,
      "createdAt": "2023-01-20T08:30:00Z",
      "updatedAt": "2023-02-15T14:20:00Z",
      "deletedAt": "2023-03-10T11:45:00Z",
      "address": "<string>"
    }
  ],
  "staffMembers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "storeId": "123e4567-e89b-12d3-a456-426614174111",
      "userId": "user-uuid",
      "scheduleId": "123e4567-e89b-12d3-a456-426614174000",
      "imageId": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "slug": "mike",
      "refreshToken": "abc123xyz456",
      "createdAt": "2025-05-01T12:00:00Z",
      "updatedAt": "2025-05-15T14:30:00Z",
      "deletedAt": "2025-06-01T09:15:00Z",
      "image": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalId": "img_123456",
        "url": "https://storage.example.com/images/product-image.jpg",
        "filename": "product-image.jpg",
        "mime": "image/jpeg",
        "createdAt": "2023-01-01T12:00:00Z",
        "updatedAt": "2023-01-02T12:00:00Z",
        "deletedAt": "2023-01-03T12:00:00Z",
        "storeId": "store-uuid"
      }
    }
  ],
  "products": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "1234567890",
      "externalVariantId": "9876543210",
      "storeId": "123e4567-e89b-12d3-a456-426614174001",
      "slug": "haircut-basic",
      "scheduleId": "<string>",
      "productPoolId": "<string>",
      "title": "Haircut Service",
      "variantTitle": "Short Hair",
      "description": "<string>",
      "imageId": "<string>",
      "color": "BLUE",
      "price": 250,
      "taxable": false,
      "duration": 3600,
      "allowCustomDuration": false,
      "maxDuration": -1,
      "maxAttendees": 1,
      "maxGuests": 123,
      "allowGuests": false,
      "allowCustomerReschedule": false,
      "allowCustomerCancel": false,
      "rescheduleGap": 123,
      "cancelGap": 123,
      "beforeGap": 123,
      "afterGap": 123,
      "fixedTimes": false,
      "fixedStartTime": "09:00:00",
      "fixedEndTime": "17:00:00",
      "advanceScheduleThreshold": 0,
      "sendConfirmationEmail": true,
      "sendReminderEmail": false,
      "sendFeedbackEmail": false,
      "skipCheckout": false,
      "status": "ACTIVE",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "image": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalId": "img_123456",
        "url": "https://storage.example.com/images/product-image.jpg",
        "filename": "product-image.jpg",
        "mime": "image/jpeg",
        "createdAt": "2023-01-01T12:00:00Z",
        "updatedAt": "2023-01-02T12:00:00Z",
        "deletedAt": "2023-01-03T12:00:00Z",
        "storeId": "store-uuid"
      }
    }
  ],
  "image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "img_123456",
    "url": "https://storage.example.com/images/product-image.jpg",
    "filename": "product-image.jpg",
    "mime": "image/jpeg",
    "createdAt": "2023-01-01T12:00:00Z",
    "updatedAt": "2023-01-02T12:00:00Z",
    "deletedAt": "2023-01-03T12:00:00Z",
    "storeId": "store-uuid"
  }
}

GET

storefront

add-ons

{addOnId}

Get an add-on by ID

curl --request GET \
  --url https://api.opencals.com/storefront/add-ons/{addOnId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.opencals.com/storefront/add-ons/{addOnId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.opencals.com/storefront/add-ons/{addOnId}', 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://api.opencals.com/storefront/add-ons/{addOnId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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://api.opencals.com/storefront/add-ons/{addOnId}"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.opencals.com/storefront/add-ons/{addOnId}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opencals.com/storefront/add-ons/{addOnId}")

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

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

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "1234567890",
  "externalVariantId": "9876543210",
  "storeId": "123e4567-e89b-12d3-a456-426614174001",
  "slug": "child-seat",
  "title": "Child Seat",
  "description": "<string>",
  "imageId": "<string>",
  "color": "slate",
  "price": 15,
  "taxable": true,
  "durationMultiplied": false,
  "maxQuantity": 4,
  "status": "active",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "images": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "img_123456",
      "url": "https://storage.example.com/images/product-image.jpg",
      "filename": "product-image.jpg",
      "mime": "image/jpeg",
      "createdAt": "2023-01-01T12:00:00Z",
      "updatedAt": "2023-01-02T12:00:00Z",
      "deletedAt": "2023-01-03T12:00:00Z",
      "storeId": "store-uuid"
    }
  ],
  "locations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "storeId": "123e4567-e89b-12d3-a456-426614174001",
      "scheduleId": "123e4567-e89b-12d3-a456-426614174002",
      "title": "Main Office",
      "description": "Our main downtown office location with 3 treatment rooms",
      "slug": "new-york",
      "type": "physical",
      "link": "https://zoom.us/j/123456789",
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 200",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94105",
      "country": "United States",
      "addressPlaceId": "ChIJIQBpAG2ahYAR_6128GcTUEo",
      "latitude": 37.4224764,
      "longitude": -122.0842499,
      "createdAt": "2023-01-20T08:30:00Z",
      "updatedAt": "2023-02-15T14:20:00Z",
      "deletedAt": "2023-03-10T11:45:00Z",
      "address": "<string>"
    }
  ],
  "staffMembers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "storeId": "123e4567-e89b-12d3-a456-426614174111",
      "userId": "user-uuid",
      "scheduleId": "123e4567-e89b-12d3-a456-426614174000",
      "imageId": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "slug": "mike",
      "refreshToken": "abc123xyz456",
      "createdAt": "2025-05-01T12:00:00Z",
      "updatedAt": "2025-05-15T14:30:00Z",
      "deletedAt": "2025-06-01T09:15:00Z",
      "image": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalId": "img_123456",
        "url": "https://storage.example.com/images/product-image.jpg",
        "filename": "product-image.jpg",
        "mime": "image/jpeg",
        "createdAt": "2023-01-01T12:00:00Z",
        "updatedAt": "2023-01-02T12:00:00Z",
        "deletedAt": "2023-01-03T12:00:00Z",
        "storeId": "store-uuid"
      }
    }
  ],
  "products": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "1234567890",
      "externalVariantId": "9876543210",
      "storeId": "123e4567-e89b-12d3-a456-426614174001",
      "slug": "haircut-basic",
      "scheduleId": "<string>",
      "productPoolId": "<string>",
      "title": "Haircut Service",
      "variantTitle": "Short Hair",
      "description": "<string>",
      "imageId": "<string>",
      "color": "BLUE",
      "price": 250,
      "taxable": false,
      "duration": 3600,
      "allowCustomDuration": false,
      "maxDuration": -1,
      "maxAttendees": 1,
      "maxGuests": 123,
      "allowGuests": false,
      "allowCustomerReschedule": false,
      "allowCustomerCancel": false,
      "rescheduleGap": 123,
      "cancelGap": 123,
      "beforeGap": 123,
      "afterGap": 123,
      "fixedTimes": false,
      "fixedStartTime": "09:00:00",
      "fixedEndTime": "17:00:00",
      "advanceScheduleThreshold": 0,
      "sendConfirmationEmail": true,
      "sendReminderEmail": false,
      "sendFeedbackEmail": false,
      "skipCheckout": false,
      "status": "ACTIVE",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "image": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalId": "img_123456",
        "url": "https://storage.example.com/images/product-image.jpg",
        "filename": "product-image.jpg",
        "mime": "image/jpeg",
        "createdAt": "2023-01-01T12:00:00Z",
        "updatedAt": "2023-01-02T12:00:00Z",
        "deletedAt": "2023-01-03T12:00:00Z",
        "storeId": "store-uuid"
      }
    }
  ],
  "image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "img_123456",
    "url": "https://storage.example.com/images/product-image.jpg",
    "filename": "product-image.jpg",
    "mime": "image/jpeg",
    "createdAt": "2023-01-01T12:00:00Z",
    "updatedAt": "2023-01-02T12:00:00Z",
    "deletedAt": "2023-01-03T12:00:00Z",
    "storeId": "store-uuid"
  }
}

Authorizations

x-api-key

string

header

default:sfk_your_api_key

required

Storefront API key (sfk_...)

Path Parameters

addOnId

string

required

Add-on ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

200 - application/json

Add-on returned

string

required

Unique identifier for the add-on

Example:

"123e4567-e89b-12d3-a456-426614174000"

externalId

string

required

External platform product ID (e.g. Shopify Product ID) for synced add-ons

Example:

"1234567890"

externalVariantId

string

required

External platform variant ID (e.g. Shopify Variant ID) for synced add-ons

Example:

"9876543210"

storeId

string

required

ID of the store that owns this add-on

Example:

"123e4567-e89b-12d3-a456-426614174001"

slug

string

required

URL-friendly slug for the add-on (unique per store)

Example:

"child-seat"

title

string

required

Title of the add-on

Example:

"Child Seat"

description

string

required

Detailed description of the add-on

imageId

string

required

ID of the primary image for the add-on

color

enum<string>

default:slate

required

Color code used when displaying the add-on

Available options:

slate,

gray,

zinc,

neutral,

stone,

red,

orange,

amber,

yellow,

lime,

green,

emerald,

teal,

cyan,

sky,

blue,

indigo,

violet,

purple,

fuchsia,

pink,

rose

Example:

"slate"

price

number

required

Unit price of the add-on

Example:

15

taxable

boolean

default:true

required

Whether the add-on is taxable

durationMultiplied

boolean

default:false

required

When true, the add-on is charged per base-duration unit of the parent appointment. Quantity on the cart/order line item mirrors the parent CartItem.quantity (i.e., the booked duration units). Only meaningful for attached products with allowCustomDuration=true.

maxQuantity

number | null

required

Maximum quantity a customer can pick for this add-on. Only applies to fixed add-ons (durationMultiplied=false). Null means unlimited.

Required range: x >= 1

Example:

4

status

enum<string>

default:active

required

Current status of the add-on

Available options:

active,

inactive

Example:

"active"

createdAt

string

required

Timestamp when the add-on was created

updatedAt

string

required

Timestamp when the add-on was last updated

deletedAt

string

required

Timestamp when the add-on was soft-deleted

images

object[]

required

Gallery images for this add-on

Show child attributes

locations

object[]

required

Locations where this add-on is available

Show child attributes

staffMembers

object[]

required

Staff members who can deliver this add-on

Show child attributes

products

object[]

required

Products that offer this add-on at checkout

Show child attributes

image

object | null

Primary image of the add-on

Show child attributes

Last modified on July 26, 2026

List add-ons for the current store Get an add-on by slug

Getting started

Endpoints

Get an add-on by ID

Authorizations

Path Parameters

Response