Skip to main content

List bookings

Method GET​

https://my.easyweek.io/api/public/v2/bookings

Description: This endpoint returns the workspace's bookings, newest reservation first, paginated. In addition to the UTC start_time/end_time, each booking exposes start_time_local/end_time_local (the same instants rendered in the location's timezone, offset-bearing) and the timezone.

Example Request​

curl -i -X GET \
  https://my.easyweek.io/api/public/v2/bookings?customer_uuid={customer_uuid}&location_uuid={location_uuid}&staffer_uuid={staffer_uuid}&state={state}&per_page={per_page} \
  -H 'Authorization: Bearer <YOUR_SECRET>' \
  -H 'Workspace: <YOUR_WORKSPACE>'

Query Parameters​

  • per_page (integer, optional): Number of items per page (alias of limit), maximum 100. Defaults to 15.
  • customer_uuid (string, optional): Only this customer's bookings.
  • location_uuid (string, optional): Only bookings at this location.
  • staffer_uuid (string, optional): Only bookings served by this staff member.
  • state (string, optional): One of upcoming (future and not closed), in_progress (spanning now and not closed), or archive (past or closed).
  • status_uuid (string, optional): A workspace-defined booking status.
  • reserved_on_from (string, optional): Inclusive lower bound on reservation time, UTC ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
  • reserved_on_to (string, optional): Inclusive upper bound on reservation time, UTC ISO 8601.
  • created_at_from (string, optional): Inclusive lower bound on creation time, UTC ISO 8601.
  • created_at_to (string, optional): Inclusive upper bound on creation time, UTC ISO 8601.

Example Response​

{
  "data": [
    {
      "uuid": "f017724b-d95a-4267-8704-df99a9edaf56",
      "location_uuid": "123b2980-3506-4f8c-abce-97e1ab653406",
      "start_time": "2026-08-15T14:00:00Z",
      "end_time": "2026-08-15T15:00:00Z",
      "start_time_local": "2026-08-15T10:00:00-04:00",
      "end_time_local": "2026-08-15T11:00:00-04:00",
      "timezone": "America/New_York",
      "duration": {
        "value": 60,
        "label": "minutes",
        "iso_8601": "PT1H"
      },
      "created_at": "2026-08-01T09:00:00Z",
      "is_canceled": false,
      "is_completed": false,
      "customer": {
        "uuid": "b6d6a1f2-6f1e-4a2b-9a2c-1f2e3d4c5b6a",
        "first_name": "Jane",
        "last_name": "Doe",
        "middle_name": null,
        "phone": "+12025550111",
        "email": "jane@example.com"
      },
      "status": {
        "uuid": "87720786-2e2c-4df8-a9f3-7719be6b41c8",
        "name": "Confirmed",
        "type": "inprogress"
      }
    }
  ],
  "links": {
    "first": "https://my.easyweek.io/api/public/v2/bookings?page=1",
    "last": "https://my.easyweek.io/api/public/v2/bookings?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://my.easyweek.io/api/public/v2/bookings",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}