Bookings

List bookings

The location's bookings that start in a period, in order of start time, one page at a time. The period is at most 62 days; read a longer one in several calls. Cancelled bookings are included, with status cancelled. A booking a customer has started online and not yet completed is not.

get/v1/locations/{locationId}/bookings

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/locations/{locationId}/bookings
  • Auth: HTTP bearer

Path parameters

locationIdstring required

Query parameters

fromstring required

Only bookings that start at or after this time, in UTC.

tostring required

Only bookings that start before this time, in UTC.

resourceIdstring

Only bookings on this resource.

customerIdstring

Only bookings for this person, company or vehicle.

limitinteger

Page size, 1 to 200. Default 50.

afterstring

The nextCursor of the previous page.

Response

OK

nextCursorstring

Pass as after to fetch the next page. Absent on the last page.

Example response

{
  "data": [
    {
      "afterTimeMinutes": 15,
      "customFields": [
        {
          "key": "allergies",
          "label": "Allergies",
          "type": "text",
          "value": "None"
        }
      ],
      "customers": [
        {
          "cancelledChannel": "web",
          "channel": "web",
          "customFields": [
            {
              "key": "allergies",
              "label": "Allergies",
              "type": "text",
              "value": "None"
            }
          ],
          "customerId": "per_2QCtWVSaVO7yCRYBj1zsbA",
          "email": "anna.lindqvist@example.com",
          "identityNumber": {
            "number": "198604122385",
            "type": "se_personnummer"
          },
          "name": "Anna Lindqvist",
          "organisationNumber": "5560360793",
          "otherPhoneNumber": "+4686543210",
          "phoneNumber": "+46701234567",
          "price": "195.00",
          "registrationNumber": "ABC123",
          "status": "booked",
          "type": "person"
        }
      ],
      "description": "Staff meeting",
      "endsAt": "2026-10-20T08:45:00Z",
      "id": "bkg_5Rt8mKq2Wn7Xb4Vd9HyLcA",
      "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
      "minPlaces": 3,
      "payments": [
        {
          "amount": "595.00",
          "customerId": "per_2QCtWVSaVO7yCRYBj1zsbA",
          "paidOn": "2026-10-18",
          "provider": "stripe",
          "refundedAmount": "0.00",
          "status": "paid",
          "type": "online"
        }
      ],
      "places": 12,
      "placesBooked": 7,
      "price": "595.00",
      "reminders": [
        {
          "customerId": "per_2QCtWVSaVO7yCRYBj1zsbA",
          "status": "delivered",
          "type": "pre_reminder"
        }
      ],
      "reservationType": "lunch",
      "resources": [
        {
          "primary": true,
          "resourceId": "res_4Hn7pQw2Zt9Lk3Vd6XyRbA"
        }
      ],
      "sales": [
        {
          "customerId": "per_2QCtWVSaVO7yCRYBj1zsbA",
          "invoiceStatus": "unpaid",
          "paidAmount": "595.00",
          "saleId": "sal_8Hd3kWq5Zn2Tb7Xc4LmPyR",
          "status": "paid",
          "type": "pos_sale"
        }
      ],
      "series": {
        "id": "bks_6Wq2nYd8Rk4Tc9Xb3HmLzP",
        "recurrenceRule": "FREQ=WEEKLY;COUNT=10"
      },
      "services": [
        {
          "durationMinutes": 45,
          "name": "Haircut",
          "price": "595.00",
          "serviceId": "svc_3Gk8rTn5Ym1Wc7Zp2LdQxB"
        }
      ],
      "startsAt": "2026-10-20T08:00:00Z",
      "status": "booked",
      "type": "appointment"
    }
  ],
  "nextCursor": "1792483200000.bkg_5Rt8mKq2Wn7Xb4Vd9HyLcA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.