Saltar a la navegación

Get All Services

Get all services for the current workspace with optional filters

Encabezados

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

Parámetros de consulta

staff_idstring or nullOpcional
asset_idstring or nullOpcional
is_activeboolean or nullOpcional
kindenum or nullOpcionalValor predeterminado: classic

What a service books.

  • classic: a staff-delivered service (haircut, consultation, massage, …).
  • rental: an asset reservation (court, room, equipment).
  • group: seats in a multi-participant session (class, workshop, tour).
Valores permitidos:

Respuesta

Respuesta correcta.
namestring
variantslist of objects
_idstring
duration_minutesintegerSolo lectura
Duration of the first variant.
pricedouble or nullSolo lectura
Price of the first variant.
pricing_modeenumOpcionalValor predeterminado: 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’.

Valores permitidos:
intake_questionslist of objectsOpcional

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 objectsOpcional

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

ungrouped_rankinteger or nullOpcional>=0

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

descriptionstringOpcional
kindenumOpcionalValor predeterminado: classic

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

Valores permitidos:
buffer_minutesintegerOpcional0-1440Valor predeterminado: 0

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

service_locationenumOpcionalValor predeterminado: business

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

Valores permitidos:
add_onslist of objectsOpcional
Optional extras that can be added to a booking of this service.
max_participantsinteger or nullOpcional2-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 nullOpcional
is_activebooleanOpcionalValor predeterminado: true
any_staff_memberbooleanOpcionalValor predeterminado: true
staff_idslist of stringsOpcional

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

asset_idslist of stringsOpcional
advance_booking_minutesintegerOpcional0-525600Valor predeterminado: 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 stringsOpcional

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

display_on_booking_pagebooleanOpcionalValor predeterminado: true
travel_minutesintegerOpcional0-480Valor predeterminado: 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_beforebooleanOpcionalValor predeterminado: true

Add travel time before the appointment (outbound trip).

travel_afterbooleanOpcionalValor predeterminado: true

Add travel time after the appointment (return trip).

promotionslist of objectsOpcional

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

created_at_unixintegerOpcional

Unix timestamp (seconds since epoch)

updated_at_unixintegerOpcional

Unix timestamp (seconds since epoch)

Errores

422
Unprocessable Entity Error