Skip to main content
GET
Search Items

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

name
string
required
Minimum string length: 2
item_type
enum<string>[] | null
Available options:
ITEM,
SERVICE,
PRODUCT,
PACKAGE,
MEMBERSHIP,
MEDICATION,
SERVICE_FEE,
GIFT_CARD
limit
integer
default:500
Required range: 1 <= x <= 500
location_id
string | null

Response

Successful Response

id
string
required

Unique identifier for the item

name
string
required

Name of the item

price
integer
required

Price of the item in cents

type
enum<string>
required

Type of item

Available options:
ITEM,
SERVICE,
PRODUCT,
PACKAGE,
MEMBERSHIP,
MEDICATION,
SERVICE_FEE,
GIFT_CARD
taxable
boolean
default:true

Whether the item is taxable

discountTemplates
DiscountTemplateWithItem · object[] | null

For packages: the package's contents