Get started

List available slots

Open times for one service

GET/v1/businesses/{businessId}/slots

Path parameters

  • businessIdstringRequired

    Business id as returned by search_businesses (prefix biz_).

Query parameters

  • serviceIdstringRequired

    Service id as returned by get_business (prefix svc_).

  • fromstring

    Earliest day/time to consider. Defaults to now. A bare YYYY-MM-DD is that whole local day; with no to it means that day only.

  • tostring

    Latest day/time to consider. A bare YYYY-MM-DD includes that whole day. Defaults to 7 days after from when from is a time (or absent), and to the same day when from is a day.

  • timeOfDaymorningafternoonevening

    Part of the business-local day: morning 05:00-12:00, afternoon 12:00-17:00, evening 17:00-22:00. For other hours use startAfter/startBefore.

  • startAfterstring

    Only slots starting at or after this business-local time of day, e.g. 17:30 for 'after 5:30pm'.

  • startBeforestring

    Only slots starting before this business-local time of day, e.g. 12:00 for 'before noon'.

  • staffIdstring

    Staff member id (prefix stf_), taken from a slot's staff.id or get_business's staff list.

  • resourceIdstring

    Only slots that use this bay, room or piece of equipment (an id from a slot's resources or the business's resources).

  • partySizeinteger (1–50)

    Number of people attending. Default 1. The slot ids returned remember it.

  • limitinteger (1–25)

    Maximum slots to return (1-25, default 6).

Responses

  • 200

    Open slots for one service, soonest first, with the business's timezone and its date today.

    SlotPage
  • 404

    No such id, or it is not visible to this key.

    NotFound