List schedule

List what is booked at the business

GET/v1/operator/schedule

curl 'https://www.yovamos.com/v1/operator/schedule?from=2027-01-12&limit=10' \
  -H "Authorization: Bearer $VAMOS_OPERATOR_KEY"

{
  "bookings": [
    {
      "id": "bkg_bk000001",
      "status": "confirmed",
      "business": {
        "id": "biz_1v8g0yh11jl8ti",
        "name": "The Spot Barbershop",
        "timezone": "America/Los_Angeles"
      },
      "service": {
        "id": "svc_1wwvyo2007ynbx",
        "name": "Haircut"
      },
      "staff": {
        "id": "stf_0ngvtdm17z44qf",
        "name": "Marcus"
      },
      "startsAt": "2027-01-12T17:00:00Z",
      "endsAt": "2027-01-12T17:45:00Z",
      "local": "Tue, Jan 12 · 9:00–9:45 AM PST",
      "durationMinutes": 45,
      "partySize": 1,
      "price": {
        "amountMinor": 3500,
        "currency": "USD",
        "display": "$35.00"
      },
      "customer": {
        "name": "Sam Rivera",
        "email": "sam@example.com"
      },
      "source": "Dots",
      "consent": {
        "statement": "Yes, book it.",
        "at": "2027-01-11T21:40:12.000Z"
      },
      "manageUrl": "https://www.yovamos.com/booking/manage?booking=bkg_bk000001",
      "createdAt": "2027-01-11T21:40:12.000Z",
      "next": [],
      "untrusted": [
        "business.name",
        "service.name",
        "staff.name",
        "customer.name",
        "consent.statement"
      ]
    }
  ]
}

Headers

AuthorizationBearer tokenRequired
Your operator key. Authentication

Query parameters

businessIdstring
Which business, if you manage more than one.
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

Search documentation

Businesses

Services

Staff

Resources

Slots

Quotes

Bookings

ScheduleOperator key

System

Guidance for apps and assistants

Headers

Query parameters

Responses