Get all bookings

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/bookings

Get information about all bookings.

Query Params

count

integer

≥ 1

Defaults to 100

The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction

string

Direction of sorting the response list.

customer_id

string

The unique ID of the customer.

booking_statuses

array of strings

List of current statuses of the bookings from resource booking-statuses.

booking_statuses

add_booking_items

string

Defaults to none

Booking items are going to be return depends on the parameter value.
Possible values: full - returns all booking items with their additional properties. / items-only - returns all booking items without additional properties. / none or no value - return no booking items

Show Deprecated

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body

object

data

object

bookings

array of objects

Collection of bookings.

bookings

object

booking_id

string

The unique ID of the booking.

customer_id

string

The unique ID of the customer that created the booking.

booking_items

array of objects

required

List of the booking items. Included in response of GET API call only if query parameter add_booking_items is true.

booking_items*

object

booking_item_id

string

The unique ID of the booking item.

customer_id

string

The unique ID of the customer.

time_slot_id

string

required

The unique ID of the booking time slot.

booking_ticket

object

Ticket of the booking item. Structure is filled only when query parameter add_booking_items has value full or items-only.

valid_from

string

Date and time when time slot starts. (YYYY-MM-DD HH:MM:SS)

valid_to

string

Date and time when time slot ends. (YYYY-MM-DD HH:MM:SS)

capacity_taken

integer

Defaults to 1

How much capacity is taken by the booking item. If not set, value is 1.

booking_item_status

string

Current status of the booking item from resource booking-statuses. If not set, CareCloud uses default booking status.

additional_properties

array of objects

List of additional property records.

additional_properties

object

property_record_id

string

The unique ID of the property record.

property_id

string

required

The unique ID of the property.

property_name

string

Name of the property.

property_value

Value of the property.

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

created_at

string

required

Date and time of the booking item. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the booking item record.
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

booking_status

string

Current status of the booking from resource booking-statuses. If not set, CareCloud uses default booking status.

utm

object

UTM structure for data from email campaign.

data

Additional data of the booking. Serialized data in JSON.

created_at

string

required

Date and time of the booking. (YYYY-MM-DD HH:MM:SS)

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the booking record.
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

total_items

integer

The number of all found bookings.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/bookings?count=100&offset=0&add_booking_items=none' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
53
}
1
{
2
  "data": {
3
    "bookings": [
4
      {
5
        "booking_id": "83d0ce2b5a1bc0dc8da01b13e7",
6
        "customer_id": "85bc5819e09dab95437552ce79",
7
        "booking_items": [
8
          {
9
            "booking_item_id": "8fd73167342d0689c4c015320",
10
            "customer_id": "8ea6abece4cd0a4ded0a29f093",
11
            "time_slot_id": "88bb88399cc74d81edbe19d684",
12
            "booking_ticket": {
13
              "ticket_id": "89d88719b8b442de2d11b401a2",
14
              "name": "Prophecy",
15
              "created_at": "2022-07-26 11:38:22",
16
              "valid_from": null,
17
              "valid_to": null,
18
              "state": 1,
19
              "last_change": "2022-09-16 16:14:41"
20
            },
21
            "valid_from": "2022-01-09 22:00:00",
22
            "valid_to": "2022-01-09 22:30:00",
23
            "capacity_taken": 2,
24
            "booking_item_status": "86e05affc7a7abefcd513ab400",
25
            "additional_properties": [

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.