跳到导航

Get Service

Get a specific service by ID

路径参数

service_idstring必需

请求头

xi-api-keystring可选
xi-workspace-idstring or null可选
The customer workspace a reseller's API key acts on.

响应

成功响应

namestring
variantslist of objects
_idstring
duration_minutesinteger只读
Duration of the first variant.
pricedouble or null只读
Price of the first variant.
pricing_modeenum可选默认为 fixed

‘fixed’ (default): the item has a known price the agent can quote, and customers can book or order it directly. ‘quote’: the price depends on the job (renovation, catering, custom work), so no price or slot is offered; the agent collects the intake_questions and files a quote request instead. Takes effect only while quotes are enabled for the business. Group services cannot use ‘quote’.

允许的值:
intake_questionslist of objects可选

Questions the agent asks before booking or ordering this item. Required for a useful pricing_mode='quote' item — without them a quote request arrives with nothing to price — but also valid on fixed-price items that need extra detail (current hair color before a dye job, allergies before a treatment).

groupslist of objects可选

Group memberships for this item. Each entry carries the group label and the item’s 0-based rank within that group.

ungrouped_rankinteger or null可选>=0

Display position among items with no group; null sorts last. Change it with the reorder endpoint.

descriptionstring可选
kindenum可选默认为 classic

Classic = staff-delivered; rental = asset-based; group = multi-participant session.

允许的值:
buffer_minutesinteger可选0-1440默认为 0

Turnover/cleanup time reserved after each booking. Applies to every service kind; default 0 means no buffer.

service_locationenum可选默认为 business

Where the service is delivered. business = client visits the business location (default); customer = staff travels to the client. Only meaningful for kind='classic'.

允许的值:
add_onslist of objects可选
Optional extras that can be added to a booking of this service.
max_participantsinteger or null可选2-200

Capacity for kind='group': how many seats a single session can sell across all registrations. Must be null for classic and rental services (those are always exclusive to one client per booking).

capacityinteger or null可选
is_activeboolean可选默认为 true
any_staff_memberboolean可选默认为 true
staff_idslist of strings可选

Staff assigned to this service; must be empty for kind=‘rental’.

asset_idslist of strings可选
advance_booking_minutesinteger可选0-525600默认为 1440

How far into the future customer-facing channels (public booking page, voice agent) may book this service. Applies to every kind.

location_idslist of strings可选

Locations where this service is offered; empty list means all locations.

display_on_booking_pageboolean可选默认为 true
travel_minutesinteger可选0-480默认为 0

Travel time in minutes added before/after appointments for customer-location services. Blocks the staff member’s calendar but is not visible to the customer. Ignored when service_location='business'.

travel_beforeboolean可选默认为 true

Add travel time before the appointment (outbound trip).

travel_afterboolean可选默认为 true

Add travel time after the appointment (return trip).

promotionslist of objects可选

Time-bound discounts applicable to this service or specific variants.

created_at_unixinteger可选

Unix timestamp (seconds since epoch)

updated_at_unixinteger可选

Unix timestamp (seconds since epoch)

错误

422
Unprocessable Entity Error