Passer à la navigation

Get Service

Get a specific service by ID

Paramètres de chemin

service_idstringRequis

En-têtes

xi-api-keystringOptionnel
xi-workspace-idstring or nullOptionnel
The customer workspace a reseller's API key acts on.

Réponse

Réponse réussie

namestring
variantslist of objects
_idstring
duration_minutesintegerLecture seule
Duration of the first variant.
pricedouble or nullLecture seule
Price of the first variant.
pricing_modeenumOptionnelPar défaut 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’.

Valeurs autorisées:
intake_questionslist of objectsOptionnel

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 objectsOptionnel

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

ungrouped_rankinteger or nullOptionnel>=0

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

descriptionstringOptionnel
kindenumOptionnelPar défaut classic

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

Valeurs autorisées:
buffer_minutesintegerOptionnel0-1440Par défaut 0

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

service_locationenumOptionnelPar défaut business

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

Valeurs autorisées:
add_onslist of objectsOptionnel
Optional extras that can be added to a booking of this service.
max_participantsinteger or nullOptionnel2-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 nullOptionnel
is_activebooleanOptionnelPar défaut true
any_staff_memberbooleanOptionnelPar défaut true
staff_idslist of stringsOptionnel

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

asset_idslist of stringsOptionnel
advance_booking_minutesintegerOptionnel0-525600Par défaut 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 stringsOptionnel

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

display_on_booking_pagebooleanOptionnelPar défaut true
travel_minutesintegerOptionnel0-480Par défaut 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_beforebooleanOptionnelPar défaut true

Add travel time before the appointment (outbound trip).

travel_afterbooleanOptionnelPar défaut true

Add travel time after the appointment (return trip).

promotionslist of objectsOptionnel

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

created_at_unixintegerOptionnel

Unix timestamp (seconds since epoch)

updated_at_unixintegerOptionnel

Unix timestamp (seconds since epoch)

Erreurs

422
Unprocessable Entity Error