Bookings

Get a booking by id

The same booking as under its location, found from its id. For a caller that holds an id and not the location it belongs to. The answer carries locationId.

get/v1/bookings/{bookingId}

Request

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

Path parameters

bookingIdstring required

Response

OK

afterTimeMinutesinteger required

Time kept free on the resource after the services, for cleaning up or resting. It is part of the time between startsAt and endsAt.

createdAtstring date-time required
descriptionstring

A text of its own for the booking: what a reservation is for, or what staff wrote in place of a service.

doneAtstring date-time

When staff set the booking as done. Left out until then.

endsAtstring date-time required

When the time held on the resource ends, in UTC. The last afterTimeMinutes of it are the time kept free after the services.

idstring required
locationIdstring required
minPlacesinteger

For a class: the fewest customers it runs with. Left out for other bookings.

notestring

Staff's note on the booking. Not shown to the customer.

placesinteger

For a class: how many places it has. Left out for other bookings.

placesBookedinteger

For a class: how many places are booked. Left out for other bookings.

pricestring

The price of the booking as a whole, when it has one. Follows "Amounts" in the introduction.

priceFromboolean required

True when the price is a starting price.

reservationTypestring

For a reservation: what the time is blocked for, in lower case, such as lunch or vacation. Left out when staff gave none. The list is open.

startsAtstring date-time required

When the booking starts, in UTC.

statusstring required

booked; show and no_show, which staff set when the customer came or did not; done, which staff set when the work is finished; or cancelled. For a class, each customer has a status of their own. More values may be added.

typestring required

appointment: a time for one customer, or for the customers that come together, such as a person and their vehicle. class: a time several customers book a place at. reservation: time blocked on the resource, with no customer. The list is open, so accept a value you do not know.

updatedAtstring date-time required

Example response

{
  "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"
}

Changes

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