Skip to main content
GET
Get grouped item counts

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string | null
sort_direction
enum<string> | null
Available options:
asc,
desc
location_id
string | null
ids
string[] | null

List of item IDs to filter by

name
string | null

Name of the item

category
string | null

Filter to items in this category, expanded through the category_closure tree by default (parent → every descendant). Set category_exact to disable expansion for grouped per-group page queries that need direct-children-only counts.

category_exact
boolean
default:false

When True, treat category as an exact match instead of expanding through the closure. Used when paginating within a grouped table so child categories don't double-appear under their parent's group.

category_search
string | null

Category of the item (fuzzy match)

categories
string[] | null

List of categories (can contain 'no-category')

brand_names
string[] | null

List of brand names (can contain 'no-brand')

settings
string[] | null

Settings toggles: 'hasExemptions', 'customPricing', 'noSettings'

usage_value
integer | null

Usage count filter value

usage_comparison
enum<string> | null

Usage count filter comparison: 'eq', 'gte', 'lte'

Available options:
eq,
gte,
lte
price_range
integer[] | null

Price range [min, max]

is_archived
boolean | null

Archived status of the item

include_archived
boolean
default:false

When True, include archived items (e.g. for checkout discounts that reference archived items)

is_physical
boolean | null

Physical status of the item

item_type
enum<string>[] | null

List of item types to filter by

Available options:
ITEM,
SERVICE,
PRODUCT,
PACKAGE,
MEMBERSHIP,
MEDICATION,
SERVICE_FEE,
GIFT_CARD
group_by
string | null

Field to group by, e.g. 'category'

tag_ids
string[] | null

Filter items that have all of the given tag IDs

Response

Successful Response

key
string
required
label
string
required
total
integer
required
depth
integer
default:0
parentKey
string | null
isSynthetic
boolean
default:false