Get started

List business schedule

What is booked at one business

GET/v1/operator/businesses/{businessId}/schedule

Headers

Path parameters

  • businessIdstringRequired

    Business id as returned by search_businesses (prefix biz_).

Query parameters

  • staffIdstring

    Only bookings with this person.

  • resourceIdstring

    Only bookings that use this bay, room or piece of equipment.

  • fromstring

    Earliest start. Default now. A bare YYYY-MM-DD is that whole local day, and with no to only that day.

  • tostring

    Latest start. A bare YYYY-MM-DD includes that day. Default: a week after from.

  • statuspendingconfirmeddeclinedcanceledexpiredcompletedno_show

    Only this status. Without it, canceled, declined and expired are left out. pending is the requests waiting for the business's decision: with no from or to it lists them all, however far off they start.

  • customerEmailstring (up to 254 characters)

    Only this customer's bookings.

  • limitinteger (1–50)

    Maximum bookings to return (1-50, default 20).

Responses

  • 200

    A page of the bookings apps made at a business, soonest first. Follow nextCursor for more.

    SchedulePage
  • 403

    The key is valid but may not do this.

    Forbidden
  • 404

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

    NotFound