List Bundles

This endpoint returns a paginated list of the company's service packs (bundles): several
services sold together at one price, each with its own price inside the pack.

Important Notes

  • Requires bundles:read scope.
  • Only active packs are listed by default. Send active=false to list only the deactivated ones.
  • items[] holds all the services of the pack, in booking order, active or not: each item
    carries the active flag of its service. price is the sum of every items[].price.
  • items[].price is the price of the service inside the pack, not its standalone price
    (GET /v3/services).
  • mode tells how the services are performed: sequential (one after another) or
    simultaneous (at the same time).
  • category carries the id and name of the pack's service category, or null when it has none.
  • To find the times a pack can be booked, send its id as bundle_id to
    GET /v3/available_slots or GET /v3/available_days.

Errors Dictionary

StatusErrorDetailDescription
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks bundles:read scope.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableconnection_failedThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to true

true (default) lists only active packs; false only the deactivated ones.

integer
≥ 1
Defaults to 1

Page number.

integer
1 to 100
Defaults to 30

Records per page (max 100).

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json