Bookings

Get the current booking for a property

GET

/properties/{id}/bookings/current

Get the current booking for a property › path Parameters

id

string · required

Property id

Get the current booking for a property › Responses

The currently ongoing booking for the property

Booking

id

string · uuid · required

Property · required

from

string · required

to

string · required

channel

string · required

channel_id

string · required

status

string · required

created_at

string · required

notes

string | null

guest_first_name

string | null

guest_last_name

string | null

guest_email

string | null

guest_phone

string | null

adults_count

integer | null

children_count

integer | null

infants_count

integer | null

special_requests

string | null

arrival_time

string | null

departure_time

string | null

checkin_completed_at

string | null

last_sync_at

string | null

ses_submitted_at

string | null

ses_batch_id

string | null

ses_last_attempt_at

string | null

ses_last_error

string | null

AccessCode[]

array | null

GET/properties/{id}/bookings/current

curl --request GET \
  --url /properties/:id/bookings/current

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "property": {
    "id": "00000000-0000-0000-0000-000000000000",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "address": "address",
    "city": "city",
    "zip_code": "zip_code",
    "country": "country",
    "ses_establishment_code": "ses_establishment_code",
    "ses_establishment_type": "ses_establishment_type",
    "has_internet": true,
    "rooms_count": 0,
    "default_cleaner": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "last_name": "last_name",
      "email": "email",
      "access_level": "access_level",
      "service": "service"
    },
    "cover_image_url": "cover_image_url",
    "role": "role",
    "calendars": [
      {
        "channel": "channel",
        "url": "url",
        "syncIntervalMinutes": 0,
        "lastSyncAt": "2024-08-25",
        "lastError": "lastError"
      }
    ],
    "smart_locks": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "vendor": "vendor",
        "name": "name"
      }
    ],
    "team": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "last_name": "last_name",
        "email": "email",
        "access_level": "access_level",
        "service": "service"
      }
    ]
  },
  "from": "from",
  "to": "to",
  "channel": "channel",
  "channel_id": "channel_id",
  "status": "status",
  "notes": "notes",
  "guest_first_name": "guest_first_name",
  "guest_last_name": "guest_last_name",
  "guest_email": "guest_email",
  "guest_phone": "guest_phone",
  "adults_count": 0,
  "children_count": 0,
  "infants_count": 0,
  "special_requests": "special_requests",
  "arrival_time": "arrival_time",
  "departure_time": "departure_time",
  "created_at": "created_at",
  "checkin_completed_at": "checkin_completed_at",
  "last_sync_at": "last_sync_at",
  "ses_submitted_at": "ses_submitted_at",
  "ses_batch_id": "ses_batch_id",
  "ses_last_attempt_at": "ses_last_attempt_at",
  "ses_last_error": "ses_last_error",
  "access_codes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "access_code": "access_code",
      "smartlock_id": "00000000-0000-0000-0000-000000000000",
      "smartlock_name": "smartlock_name"
    }
  ],
  "guests": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "booking_id": "00000000-0000-0000-0000-000000000000",
      "property_id": "00000000-0000-0000-0000-000000000000",
      "first_name": "first_name",
      "last_name": "last_name",
      "second_last_name": "second_last_name",
      "nationality": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "name_es": "name_es",
        "alpha_2": "alpha_2",
        "alpha_3": "alpha_3"
      },
      "date_of_birth": "date_of_birth",
      "sex": "sex",
      "residence_country": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "name_es": "name_es",
        "alpha_2": "alpha_2",
        "alpha_3": "alpha_3"
      },
      "residence_province": {
        "id": "00000000-0000-0000-0000-000000000000",
        "country_id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "code_iso_3166_2": "code_iso_3166_2",
        "ine_code_pro": "ine_code_pro"
      },
      "residence_city": {
        "id": "00000000-0000-0000-0000-000000000000",
        "country_id": "00000000-0000-0000-0000-000000000000",
        "province_id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "ine_code": "ine_code",
        "ine_code_mun": "ine_code_mun"
      },
      "residence_city_name": "residence_city_name",
      "residence_address": "residence_address",
      "residence_postal_code": "residence_postal_code",
      "document_type": "document_type",
      "document_number": "document_number",
      "document_support_number": "document_support_number",
      "email": "email",
      "phone": "phone",
      "phone_prefix": "phone_prefix",
      "relationship_code": "relationship_code"
    }
  ],
  "cleaning_task": {
    "id": "00000000-0000-0000-0000-000000000000",
    "property": {
      "id": "00000000-0000-0000-0000-000000000000",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "address": "address",
      "city": "city",
      "zip_code": "zip_code",
      "country": "country",
      "ses_establishment_code": "ses_establishment_code",
      "ses_establishment_type": "ses_establishment_type",
      "has_internet": true,
      "rooms_count": 0,
      "default_cleaner": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "last_name": "last_name",
        "email": "email",
        "access_level": "access_level",
        "service": "service"
      },
      "cover_image_url": "cover_image_url",
      "role": "role",
      "calendars": [
        {
          "channel": "channel",
          "url": "url",
          "syncIntervalMinutes": 0,
          "lastSyncAt": "2024-08-25",
          "lastError": "lastError"
        }
      ],
      "smart_locks": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "vendor": "vendor",
          "name": "name"
        }
      ],
      "team": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "name",
          "last_name": "last_name",
          "email": "email",
          "access_level": "access_level",
          "service": "service"
        }
      ]
    },
    "booking_id": "00000000-0000-0000-0000-000000000000",
    "task_type": "booking",
    "status": "pending",
    "assigned_to": "00000000-0000-0000-0000-000000000000",
    "assigned_to_name": "assigned_to_name",
    "notes": "notes",
    "job_report": "job_report",
    "scheduled_date": "scheduled_date",
    "scheduled_start_time": "scheduled_start_time",
    "scheduled_end_time": "scheduled_end_time",
    "created_at": "created_at",
    "started_at": "started_at",
    "completed_at": "completed_at",
    "cancelled_at": "cancelled_at",
    "next_booking": null,
    "access": "access",
    "public_token": "public_token"
  }
}

json

application/json

List bookings for a property

GET

/properties/{id}/bookings

List bookings for a property › path Parameters

id

string · required

Property id

List bookings for a property › query Parameters

page

string

Zero-based page index (default 0)

size

string

Page size (max 100)

from

string

Filter bookings starting on or after this date (ISO-8601)

to

string

Filter bookings ending on or before this date (ISO-8601)

channel

string

Filter by booking channel

query

string

Free-text search across guest fields and notes

sortBy

string

Sort field: CHECKIN or CHECKOUT

sortDescending

string

Sort descending when true

List bookings for a property › Responses

Paginated bookings for the property

BookingsResponse

Booking[] · required

page

integer | null

size

integer | null

total

integer | null

GET/properties/{id}/bookings

curl --request GET \
  --url /properties/:id/bookings

shell

Example Responses

{
  "bookings": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "property": {
        "id": "00000000-0000-0000-0000-000000000000",
        "account_id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "address": "address",
        "city": "city",
        "zip_code": "zip_code",
        "country": "country",
        "ses_establishment_code": "ses_establishment_code",
        "ses_establishment_type": "ses_establishment_type",
        "has_internet": true,
        "rooms_count": 0,
        "default_cleaner": {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "name",
          "last_name": "last_name",
          "email": "email",
          "access_level": "access_level",
          "service": "service"
        },
        "cover_image_url": "cover_image_url",
        "role": "role",
        "calendars": [
          {
            "channel": "channel",
            "url": "url",
            "syncIntervalMinutes": 0,
            "lastSyncAt": "2024-08-25",
            "lastError": "lastError"
          }
        ],
        "smart_locks": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "vendor": "vendor",
            "name": "name"
          }
        ],
        "team": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "last_name": "last_name",
            "email": "email",
            "access_level": "access_level",
            "service": "service"
          }
        ]
      },
      "from": "from",
      "to": "to",
      "channel": "channel",
      "channel_id": "channel_id",
      "status": "status",
      "notes": "notes",
      "guest_first_name": "guest_first_name",
      "guest_last_name": "guest_last_name",
      "guest_email": "guest_email",
      "guest_phone": "guest_phone",
      "adults_count": 0,
      "children_count": 0,
      "infants_count": 0,
      "special_requests": "special_requests",
      "arrival_time": "arrival_time",
      "departure_time": "departure_time",
      "created_at": "created_at",
      "checkin_completed_at": "checkin_completed_at",
      "last_sync_at": "last_sync_at",
      "ses_submitted_at": "ses_submitted_at",
      "ses_batch_id": "ses_batch_id",
      "ses_last_attempt_at": "ses_last_attempt_at",
      "ses_last_error": "ses_last_error",
      "access_codes": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "access_code": "access_code",
          "smartlock_id": "00000000-0000-0000-0000-000000000000",
          "smartlock_name": "smartlock_name"
        }
      ],
      "guests": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "booking_id": "00000000-0000-0000-0000-000000000000",
          "property_id": "00000000-0000-0000-0000-000000000000",
          "first_name": "first_name",
          "last_name": "last_name",
          "second_last_name": "second_last_name",
          "nationality": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "name_es": "name_es",
            "alpha_2": "alpha_2",
            "alpha_3": "alpha_3"
          },
          "date_of_birth": "date_of_birth",
          "sex": "sex",
          "residence_country": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "name_es": "name_es",
            "alpha_2": "alpha_2",
            "alpha_3": "alpha_3"
          },
          "residence_province": {
            "id": "00000000-0000-0000-0000-000000000000",
            "country_id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "code_iso_3166_2": "code_iso_3166_2",
            "ine_code_pro": "ine_code_pro"
          },
          "residence_city": {
            "id": "00000000-0000-0000-0000-000000000000",
            "country_id": "00000000-0000-0000-0000-000000000000",
            "province_id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "ine_code": "ine_code",
            "ine_code_mun": "ine_code_mun"
          },
          "residence_city_name": "residence_city_name",
          "residence_address": "residence_address",
          "residence_postal_code": "residence_postal_code",
          "document_type": "document_type",
          "document_number": "document_number",
          "document_support_number": "document_support_number",
          "email": "email",
          "phone": "phone",
          "phone_prefix": "phone_prefix",
          "relationship_code": "relationship_code"
        }
      ],
      "cleaning_task": {
        "id": "00000000-0000-0000-0000-000000000000",
        "property": {
          "id": "00000000-0000-0000-0000-000000000000",
          "account_id": "00000000-0000-0000-0000-000000000000",
          "name": "name",
          "address": "address",
          "city": "city",
          "zip_code": "zip_code",
          "country": "country",
          "ses_establishment_code": "ses_establishment_code",
          "ses_establishment_type": "ses_establishment_type",
          "has_internet": true,
          "rooms_count": 0,
          "default_cleaner": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "last_name": "last_name",
            "email": "email",
            "access_level": "access_level",
            "service": "service"
          },
          "cover_image_url": "cover_image_url",
          "role": "role",
          "calendars": [
            {
              "channel": "channel",
              "url": "url",
              "syncIntervalMinutes": 0,
              "lastSyncAt": "2024-08-25",
              "lastError": "lastError"
            }
          ],
          "smart_locks": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "vendor": "vendor",
              "name": "name"
            }
          ],
          "team": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "name": "name",
              "last_name": "last_name",
              "email": "email",
              "access_level": "access_level",
              "service": "service"
            }
          ]
        },
        "booking_id": "00000000-0000-0000-0000-000000000000",
        "task_type": "booking",
        "status": "pending",
        "assigned_to": "00000000-0000-0000-0000-000000000000",
        "assigned_to_name": "assigned_to_name",
        "notes": "notes",
        "job_report": "job_report",
        "scheduled_date": "scheduled_date",
        "scheduled_start_time": "scheduled_start_time",
        "scheduled_end_time": "scheduled_end_time",
        "created_at": "created_at",
        "started_at": "started_at",
        "completed_at": "completed_at",
        "cancelled_at": "cancelled_at",
        "next_booking": null,
        "access": "access",
        "public_token": "public_token"
      }
    }
  ],
  "page": 0,
  "size": 0,
  "total": 0
}

json

application/json

Create a booking for a property

POST

/properties/{id}/bookings

Create a booking for a property › path Parameters

id

string · required

Property id

Create a booking for a property › Request Body

BookingData

from

string | null

to

string | null

channel

string | null

channel_id

string | null

status

string | null

notes

string | null

guest_first_name

string | null

guest_last_name

string | null

guest_email

string | null

guest_phone

string | null

adults_count

integer | null

children_count

integer | null

infants_count

integer | null

special_requests

string | null

arrival_time

string | null

departure_time

string | null

Create a booking for a property › Responses

The created booking

Booking

id

string · uuid · required

Property · required

from

string · required

to

string · required

channel

string · required

channel_id

string · required

status

string · required

created_at

string · required

notes

string | null

guest_first_name

string | null

guest_last_name

string | null

guest_email

string | null

guest_phone

string | null

adults_count

integer | null

children_count

integer | null

infants_count

integer | null

special_requests

string | null

arrival_time

string | null

departure_time

string | null

checkin_completed_at

string | null

last_sync_at

string | null

ses_submitted_at

string | null

ses_batch_id

string | null

ses_last_attempt_at

string | null

ses_last_error

string | null

AccessCode[]

array | null

POST/properties/{id}/bookings

curl --request POST \
  --url /properties/:id/bookings \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "from",
  "to": "to",
  "channel": "channel",
  "channel_id": "channel_id",
  "status": "status",
  "notes": "notes",
  "guest_first_name": "guest_first_name",
  "guest_last_name": "guest_last_name",
  "guest_email": "guest_email",
  "guest_phone": "guest_phone",
  "adults_count": 0,
  "children_count": 0,
  "infants_count": 0,
  "special_requests": "special_requests",
  "arrival_time": "arrival_time",
  "departure_time": "departure_time"
}
'

shell

Example Request Body

{
  "from": "from",
  "to": "to",
  "channel": "channel",
  "channel_id": "channel_id",
  "status": "status",
  "notes": "notes",
  "guest_first_name": "guest_first_name",
  "guest_last_name": "guest_last_name",
  "guest_email": "guest_email",
  "guest_phone": "guest_phone",
  "adults_count": 0,
  "children_count": 0,
  "infants_count": 0,
  "special_requests": "special_requests",
  "arrival_time": "arrival_time",
  "departure_time": "departure_time"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "property": {
    "id": "00000000-0000-0000-0000-000000000000",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "address": "address",
    "city": "city",
    "zip_code": "zip_code",
    "country": "country",
    "ses_establishment_code": "ses_establishment_code",
    "ses_establishment_type": "ses_establishment_type",
    "has_internet": true,
    "rooms_count": 0,
    "default_cleaner": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "last_name": "last_name",
      "email": "email",
      "access_level": "access_level",
      "service": "service"
    },
    "cover_image_url": "cover_image_url",
    "role": "role",
    "calendars": [
      {
        "channel": "channel",
        "url": "url",
        "syncIntervalMinutes": 0,
        "lastSyncAt": "2024-08-25",
        "lastError": "lastError"
      }
    ],
    "smart_locks": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "vendor": "vendor",
        "name": "name"
      }
    ],
    "team": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "last_name": "last_name",
        "email": "email",
        "access_level": "access_level",
        "service": "service"
      }
    ]
  },
  "from": "from",
  "to": "to",
  "channel": "channel",
  "channel_id": "channel_id",
  "status": "status",
  "notes": "notes",
  "guest_first_name": "guest_first_name",
  "guest_last_name": "guest_last_name",
  "guest_email": "guest_email",
  "guest_phone": "guest_phone",
  "adults_count": 0,
  "children_count": 0,
  "infants_count": 0,
  "special_requests": "special_requests",
  "arrival_time": "arrival_time",
  "departure_time": "departure_time",
  "created_at": "created_at",
  "checkin_completed_at": "checkin_completed_at",
  "last_sync_at": "last_sync_at",
  "ses_submitted_at": "ses_submitted_at",
  "ses_batch_id": "ses_batch_id",
  "ses_last_attempt_at": "ses_last_attempt_at",
  "ses_last_error": "ses_last_error",
  "access_codes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "access_code": "access_code",
      "smartlock_id": "00000000-0000-0000-0000-000000000000",
      "smartlock_name": "smartlock_name"
    }
  ],
  "guests": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "booking_id": "00000000-0000-0000-0000-000000000000",
      "property_id": "00000000-0000-0000-0000-000000000000",
      "first_name": "first_name",
      "last_name": "last_name",
      "second_last_name": "second_last_name",
      "nationality": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "name_es": "name_es",
        "alpha_2": "alpha_2",
        "alpha_3": "alpha_3"
      },
      "date_of_birth": "date_of_birth",
      "sex": "sex",
      "residence_country": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "name_es": "name_es",
        "alpha_2": "alpha_2",
        "alpha_3": "alpha_3"
      },
      "residence_province": {
        "id": "00000000-0000-0000-0000-000000000000",
        "country_id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "code_iso_3166_2": "code_iso_3166_2",
        "ine_code_pro": "ine_code_pro"
      },
      "residence_city": {
        "id": "00000000-0000-0000-0000-000000000000",
        "country_id": "00000000-0000-0000-0000-000000000000",
        "province_id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "ine_code": "ine_code",
        "ine_code_mun": "ine_code_mun"
      },
      "residence_city_name": "residence_city_name",
      "residence_address": "residence_address",
      "residence_postal_code": "residence_postal_code",
      "document_type": "document_type",
      "document_number": "document_number",
      "document_support_number": "document_support_number",
      "email": "email",
      "phone": "phone",
      "phone_prefix": "phone_prefix",
      "relationship_code": "relationship_code"
    }
  ],
  "cleaning_task": {
    "id": "00000000-0000-0000-0000-000000000000",
    "property": {
      "id": "00000000-0000-0000-0000-000000000000",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "address": "address",
      "city": "city",
      "zip_code": "zip_code",
      "country": "country",
      "ses_establishment_code": "ses_establishment_code",
      "ses_establishment_type": "ses_establishment_type",
      "has_internet": true,
      "rooms_count": 0,
      "default_cleaner": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "last_name": "last_name",
        "email": "email",
        "access_level": "access_level",
        "service": "service"
      },
      "cover_image_url": "cover_image_url",
      "role": "role",
      "calendars": [
        {
          "channel": "channel",
          "url": "url",
          "syncIntervalMinutes": 0,
          "lastSyncAt": "2024-08-25",
          "lastError": "lastError"
        }
      ],
      "smart_locks": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "vendor": "vendor",
          "name": "name"
        }
      ],
      "team": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "name",
          "last_name": "last_name",
          "email": "email",
          "access_level": "access_level",
          "service": "service"
        }
      ]
    },
    "booking_id": "00000000-0000-0000-0000-000000000000",
    "task_type": "booking",
    "status": "pending",
    "assigned_to": "00000000-0000-0000-0000-000000000000",
    "assigned_to_name": "assigned_to_name",
    "notes": "notes",
    "job_report": "job_report",
    "scheduled_date": "scheduled_date",
    "scheduled_start_time": "scheduled_start_time",
    "scheduled_end_time": "scheduled_end_time",
    "created_at": "created_at",
    "started_at": "started_at",
    "completed_at": "completed_at",
    "cancelled_at": "cancelled_at",
    "next_booking": null,
    "access": "access",
    "public_token": "public_token"
  }
}

json

application/json

List bookings across all properties the caller can access

GET

/bookings

List bookings across all properties the caller can access › query Parameters

page

string

Zero-based page index (default 0)

size

string

Page size (max 100)

from

string

Filter bookings starting on or after this date (ISO-8601)

to

string

Filter bookings ending on or before this date (ISO-8601)

propertyId

string

Restrict to a single property

channel

string

Filter by booking channel

query

string

Free-text search across guest fields and notes

sortBy

string

Sort field: CHECKIN or CHECKOUT

sortDescending

string

Sort descending when true

List bookings across all properties the caller can access › Responses

Paginated bookings across accessible properties

BookingsResponse

Booking[] · required

page

integer | null

size

integer | null

total

integer | null

GET/bookings

curl --request GET \
  --url /bookings

shell

Example Responses

{
  "bookings": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "property": {
        "id": "00000000-0000-0000-0000-000000000000",
        "account_id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "address": "address",
        "city": "city",
        "zip_code": "zip_code",
        "country": "country",
        "ses_establishment_code": "ses_establishment_code",
        "ses_establishment_type": "ses_establishment_type",
        "has_internet": true,
        "rooms_count": 0,
        "default_cleaner": {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "name",
          "last_name": "last_name",
          "email": "email",
          "access_level": "access_level",
          "service": "service"
        },
        "cover_image_url": "cover_image_url",
        "role": "role",
        "calendars": [
          {
            "channel": "channel",
            "url": "url",
            "syncIntervalMinutes": 0,
            "lastSyncAt": "2024-08-25",
            "lastError": "lastError"
          }
        ],
        "smart_locks": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "vendor": "vendor",
            "name": "name"
          }
        ],
        "team": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "last_name": "last_name",
            "email": "email",
            "access_level": "access_level",
            "service": "service"
          }
        ]
      },
      "from": "from",
      "to": "to",
      "channel": "channel",
      "channel_id": "channel_id",
      "status": "status",
      "notes": "notes",
      "guest_first_name": "guest_first_name",
      "guest_last_name": "guest_last_name",
      "guest_email": "guest_email",
      "guest_phone": "guest_phone",
      "adults_count": 0,
      "children_count": 0,
      "infants_count": 0,
      "special_requests": "special_requests",
      "arrival_time": "arrival_time",
      "departure_time": "departure_time",
      "created_at": "created_at",
      "checkin_completed_at": "checkin_completed_at",
      "last_sync_at": "last_sync_at",
      "ses_submitted_at": "ses_submitted_at",
      "ses_batch_id": "ses_batch_id",
      "ses_last_attempt_at": "ses_last_attempt_at",
      "ses_last_error": "ses_last_error",
      "access_codes": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "access_code": "access_code",
          "smartlock_id": "00000000-0000-0000-0000-000000000000",
          "smartlock_name": "smartlock_name"
        }
      ],
      "guests": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "booking_id": "00000000-0000-0000-0000-000000000000",
          "property_id": "00000000-0000-0000-0000-000000000000",
          "first_name": "first_name",
          "last_name": "last_name",
          "second_last_name": "second_last_name",
          "nationality": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "name_es": "name_es",
            "alpha_2": "alpha_2",
            "alpha_3": "alpha_3"
          },
          "date_of_birth": "date_of_birth",
          "sex": "sex",
          "residence_country": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "name_es": "name_es",
            "alpha_2": "alpha_2",
            "alpha_3": "alpha_3"
          },
          "residence_province": {
            "id": "00000000-0000-0000-0000-000000000000",
            "country_id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "code_iso_3166_2": "code_iso_3166_2",
            "ine_code_pro": "ine_code_pro"
          },
          "residence_city": {
            "id": "00000000-0000-0000-0000-000000000000",
            "country_id": "00000000-0000-0000-0000-000000000000",
            "province_id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "ine_code": "ine_code",
            "ine_code_mun": "ine_code_mun"
          },
          "residence_city_name": "residence_city_name",
          "residence_address": "residence_address",
          "residence_postal_code": "residence_postal_code",
          "document_type": "document_type",
          "document_number": "document_number",
          "document_support_number": "document_support_number",
          "email": "email",
          "phone": "phone",
          "phone_prefix": "phone_prefix",
          "relationship_code": "relationship_code"
        }
      ],
      "cleaning_task": {
        "id": "00000000-0000-0000-0000-000000000000",
        "property": {
          "id": "00000000-0000-0000-0000-000000000000",
          "account_id": "00000000-0000-0000-0000-000000000000",
          "name": "name",
          "address": "address",
          "city": "city",
          "zip_code": "zip_code",
          "country": "country",
          "ses_establishment_code": "ses_establishment_code",
          "ses_establishment_type": "ses_establishment_type",
          "has_internet": true,
          "rooms_count": 0,
          "default_cleaner": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "last_name": "last_name",
            "email": "email",
            "access_level": "access_level",
            "service": "service"
          },
          "cover_image_url": "cover_image_url",
          "role": "role",
          "calendars": [
            {
              "channel": "channel",
              "url": "url",
              "syncIntervalMinutes": 0,
              "lastSyncAt": "2024-08-25",
              "lastError": "lastError"
            }
          ],
          "smart_locks": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "vendor": "vendor",
              "name": "name"
            }
          ],
          "team": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "name": "name",
              "last_name": "last_name",
              "email": "email",
              "access_level": "access_level",
              "service": "service"
            }
          ]
        },
        "booking_id": "00000000-0000-0000-0000-000000000000",
        "task_type": "booking",
        "status": "pending",
        "assigned_to": "00000000-0000-0000-0000-000000000000",
        "assigned_to_name": "assigned_to_name",
        "notes": "notes",
        "job_report": "job_report",
        "scheduled_date": "scheduled_date",
        "scheduled_start_time": "scheduled_start_time",
        "scheduled_end_time": "scheduled_end_time",
        "created_at": "created_at",
        "started_at": "started_at",
        "completed_at": "completed_at",
        "cancelled_at": "cancelled_at",
        "next_booking": null,
        "access": "access",
        "public_token": "public_token"
      }
    }
  ],
  "page": 0,
  "size": 0,
  "total": 0
}

json

application/json

Get a booking by id

GET

/bookings/{id}

Get a booking by id › path Parameters

id

string · required

Booking id

Get a booking by id › Responses

The booking, including access codes, guests, and cleaning task when visible

Booking

id

string · uuid · required

Property · required

from

string · required

to

string · required

channel

string · required

channel_id

string · required

status

string · required

created_at

string · required

notes

string | null

guest_first_name

string | null

guest_last_name

string | null

guest_email

string | null

guest_phone

string | null

adults_count

integer | null

children_count

integer | null

infants_count

integer | null

special_requests

string | null

arrival_time

string | null

departure_time

string | null

checkin_completed_at

string | null

last_sync_at

string | null

ses_submitted_at

string | null

ses_batch_id

string | null

ses_last_attempt_at

string | null

ses_last_error

string | null

AccessCode[]

array | null

GET/bookings/{id}

curl --request GET \
  --url /bookings/:id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "property": {
    "id": "00000000-0000-0000-0000-000000000000",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "address": "address",
    "city": "city",
    "zip_code": "zip_code",
    "country": "country",
    "ses_establishment_code": "ses_establishment_code",
    "ses_establishment_type": "ses_establishment_type",
    "has_internet": true,
    "rooms_count": 0,
    "default_cleaner": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "last_name": "last_name",
      "email": "email",
      "access_level": "access_level",
      "service": "service"
    },
    "cover_image_url": "cover_image_url",
    "role": "role",
    "calendars": [
      {
        "channel": "channel",
        "url": "url",
        "syncIntervalMinutes": 0,
        "lastSyncAt": "2024-08-25",
        "lastError": "lastError"
      }
    ],
    "smart_locks": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "vendor": "vendor",
        "name": "name"
      }
    ],
    "team": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "last_name": "last_name",
        "email": "email",
        "access_level": "access_level",
        "service": "service"
      }
    ]
  },
  "from": "from",
  "to": "to",
  "channel": "channel",
  "channel_id": "channel_id",
  "status": "status",
  "notes": "notes",
  "guest_first_name": "guest_first_name",
  "guest_last_name": "guest_last_name",
  "guest_email": "guest_email",
  "guest_phone": "guest_phone",
  "adults_count": 0,
  "children_count": 0,
  "infants_count": 0,
  "special_requests": "special_requests",
  "arrival_time": "arrival_time",
  "departure_time": "departure_time",
  "created_at": "created_at",
  "checkin_completed_at": "checkin_completed_at",
  "last_sync_at": "last_sync_at",
  "ses_submitted_at": "ses_submitted_at",
  "ses_batch_id": "ses_batch_id",
  "ses_last_attempt_at": "ses_last_attempt_at",
  "ses_last_error": "ses_last_error",
  "access_codes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "access_code": "access_code",
      "smartlock_id": "00000000-0000-0000-0000-000000000000",
      "smartlock_name": "smartlock_name"
    }
  ],
  "guests": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "booking_id": "00000000-0000-0000-0000-000000000000",
      "property_id": "00000000-0000-0000-0000-000000000000",
      "first_name": "first_name",
      "last_name": "last_name",
      "second_last_name": "second_last_name",
      "nationality": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "name_es": "name_es",
        "alpha_2": "alpha_2",
        "alpha_3": "alpha_3"
      },
      "date_of_birth": "date_of_birth",
      "sex": "sex",
      "residence_country": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "name_es": "name_es",
        "alpha_2": "alpha_2",
        "alpha_3": "alpha_3"
      },
      "residence_province": {
        "id": "00000000-0000-0000-0000-000000000000",
        "country_id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "code_iso_3166_2": "code_iso_3166_2",
        "ine_code_pro": "ine_code_pro"
      },
      "residence_city": {
        "id": "00000000-0000-0000-0000-000000000000",
        "country_id": "00000000-0000-0000-0000-000000000000",
        "province_id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "ine_code": "ine_code",
        "ine_code_mun": "ine_code_mun"
      },
      "residence_city_name": "residence_city_name",
      "residence_address": "residence_address",
      "residence_postal_code": "residence_postal_code",
      "document_type": "document_type",
      "document_number": "document_number",
      "document_support_number": "document_support_number",
      "email": "email",
      "phone": "phone",
      "phone_prefix": "phone_prefix",
      "relationship_code": "relationship_code"
    }
  ],
  "cleaning_task": {
    "id": "00000000-0000-0000-0000-000000000000",
    "property": {
      "id": "00000000-0000-0000-0000-000000000000",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "address": "address",
      "city": "city",
      "zip_code": "zip_code",
      "country": "country",
      "ses_establishment_code": "ses_establishment_code",
      "ses_establishment_type": "ses_establishment_type",
      "has_internet": true,
      "rooms_count": 0,
      "default_cleaner": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "last_name": "last_name",
        "email": "email",
        "access_level": "access_level",
        "service": "service"
      },
      "cover_image_url": "cover_image_url",
      "role": "role",
      "calendars": [
        {
          "channel": "channel",
          "url": "url",
          "syncIntervalMinutes": 0,
          "lastSyncAt": "2024-08-25",
          "lastError": "lastError"
        }
      ],
      "smart_locks": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "vendor": "vendor",
          "name": "name"
        }
      ],
      "team": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "name",
          "last_name": "last_name",
          "email": "email",
          "access_level": "access_level",
          "service": "service"
        }
      ]
    },
    "booking_id": "00000000-0000-0000-0000-000000000000",
    "task_type": "booking",
    "status": "pending",
    "assigned_to": "00000000-0000-0000-0000-000000000000",
    "assigned_to_name": "assigned_to_name",
    "notes": "notes",
    "job_report": "job_report",
    "scheduled_date": "scheduled_date",
    "scheduled_start_time": "scheduled_start_time",
    "scheduled_end_time": "scheduled_end_time",
    "created_at": "created_at",
    "started_at": "started_at",
    "completed_at": "completed_at",
    "cancelled_at": "cancelled_at",
    "next_booking": null,
    "access": "access",
    "public_token": "public_token"
  }
}

json

application/json

Update a booking

PATCH

/bookings/{id}

Update a booking › path Parameters

id

string · required

Booking id

Update a booking › Request Body

BookingData

from

string | null

to

string | null

channel

string | null

channel_id

string | null

status

string | null

notes

string | null

guest_first_name

string | null

guest_last_name

string | null

guest_email

string | null

guest_phone

string | null

adults_count

integer | null

children_count

integer | null

infants_count

integer | null

special_requests

string | null

arrival_time

string | null

departure_time

string | null

Update a booking › Responses

The updated booking

Booking

id

string · uuid · required

Property · required

from

string · required

to

string · required

channel

string · required

channel_id

string · required

status

string · required

created_at

string · required

notes

string | null

guest_first_name

string | null

guest_last_name

string | null

guest_email

string | null

guest_phone

string | null

adults_count

integer | null

children_count

integer | null

infants_count

integer | null

special_requests

string | null

arrival_time

string | null

departure_time

string | null

checkin_completed_at

string | null

last_sync_at

string | null

ses_submitted_at

string | null

ses_batch_id

string | null

ses_last_attempt_at

string | null

ses_last_error

string | null

AccessCode[]

array | null

PATCH/bookings/{id}

curl --request PATCH \
  --url /bookings/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "from",
  "to": "to",
  "channel": "channel",
  "channel_id": "channel_id",
  "status": "status",
  "notes": "notes",
  "guest_first_name": "guest_first_name",
  "guest_last_name": "guest_last_name",
  "guest_email": "guest_email",
  "guest_phone": "guest_phone",
  "adults_count": 0,
  "children_count": 0,
  "infants_count": 0,
  "special_requests": "special_requests",
  "arrival_time": "arrival_time",
  "departure_time": "departure_time"
}
'

shell

Example Request Body

{
  "from": "from",
  "to": "to",
  "channel": "channel",
  "channel_id": "channel_id",
  "status": "status",
  "notes": "notes",
  "guest_first_name": "guest_first_name",
  "guest_last_name": "guest_last_name",
  "guest_email": "guest_email",
  "guest_phone": "guest_phone",
  "adults_count": 0,
  "children_count": 0,
  "infants_count": 0,
  "special_requests": "special_requests",
  "arrival_time": "arrival_time",
  "departure_time": "departure_time"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "property": {
    "id": "00000000-0000-0000-0000-000000000000",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "address": "address",
    "city": "city",
    "zip_code": "zip_code",
    "country": "country",
    "ses_establishment_code": "ses_establishment_code",
    "ses_establishment_type": "ses_establishment_type",
    "has_internet": true,
    "rooms_count": 0,
    "default_cleaner": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "last_name": "last_name",
      "email": "email",
      "access_level": "access_level",
      "service": "service"
    },
    "cover_image_url": "cover_image_url",
    "role": "role",
    "calendars": [
      {
        "channel": "channel",
        "url": "url",
        "syncIntervalMinutes": 0,
        "lastSyncAt": "2024-08-25",
        "lastError": "lastError"
      }
    ],
    "smart_locks": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "vendor": "vendor",
        "name": "name"
      }
    ],
    "team": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "last_name": "last_name",
        "email": "email",
        "access_level": "access_level",
        "service": "service"
      }
    ]
  },
  "from": "from",
  "to": "to",
  "channel": "channel",
  "channel_id": "channel_id",
  "status": "status",
  "notes": "notes",
  "guest_first_name": "guest_first_name",
  "guest_last_name": "guest_last_name",
  "guest_email": "guest_email",
  "guest_phone": "guest_phone",
  "adults_count": 0,
  "children_count": 0,
  "infants_count": 0,
  "special_requests": "special_requests",
  "arrival_time": "arrival_time",
  "departure_time": "departure_time",
  "created_at": "created_at",
  "checkin_completed_at": "checkin_completed_at",
  "last_sync_at": "last_sync_at",
  "ses_submitted_at": "ses_submitted_at",
  "ses_batch_id": "ses_batch_id",
  "ses_last_attempt_at": "ses_last_attempt_at",
  "ses_last_error": "ses_last_error",
  "access_codes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "access_code": "access_code",
      "smartlock_id": "00000000-0000-0000-0000-000000000000",
      "smartlock_name": "smartlock_name"
    }
  ],
  "guests": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "booking_id": "00000000-0000-0000-0000-000000000000",
      "property_id": "00000000-0000-0000-0000-000000000000",
      "first_name": "first_name",
      "last_name": "last_name",
      "second_last_name": "second_last_name",
      "nationality": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "name_es": "name_es",
        "alpha_2": "alpha_2",
        "alpha_3": "alpha_3"
      },
      "date_of_birth": "date_of_birth",
      "sex": "sex",
      "residence_country": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "name_es": "name_es",
        "alpha_2": "alpha_2",
        "alpha_3": "alpha_3"
      },
      "residence_province": {
        "id": "00000000-0000-0000-0000-000000000000",
        "country_id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "code_iso_3166_2": "code_iso_3166_2",
        "ine_code_pro": "ine_code_pro"
      },
      "residence_city": {
        "id": "00000000-0000-0000-0000-000000000000",
        "country_id": "00000000-0000-0000-0000-000000000000",
        "province_id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "ine_code": "ine_code",
        "ine_code_mun": "ine_code_mun"
      },
      "residence_city_name": "residence_city_name",
      "residence_address": "residence_address",
      "residence_postal_code": "residence_postal_code",
      "document_type": "document_type",
      "document_number": "document_number",
      "document_support_number": "document_support_number",
      "email": "email",
      "phone": "phone",
      "phone_prefix": "phone_prefix",
      "relationship_code": "relationship_code"
    }
  ],
  "cleaning_task": {
    "id": "00000000-0000-0000-0000-000000000000",
    "property": {
      "id": "00000000-0000-0000-0000-000000000000",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "address": "address",
      "city": "city",
      "zip_code": "zip_code",
      "country": "country",
      "ses_establishment_code": "ses_establishment_code",
      "ses_establishment_type": "ses_establishment_type",
      "has_internet": true,
      "rooms_count": 0,
      "default_cleaner": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "last_name": "last_name",
        "email": "email",
        "access_level": "access_level",
        "service": "service"
      },
      "cover_image_url": "cover_image_url",
      "role": "role",
      "calendars": [
        {
          "channel": "channel",
          "url": "url",
          "syncIntervalMinutes": 0,
          "lastSyncAt": "2024-08-25",
          "lastError": "lastError"
        }
      ],
      "smart_locks": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "vendor": "vendor",
          "name": "name"
        }
      ],
      "team": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "name",
          "last_name": "last_name",
          "email": "email",
          "access_level": "access_level",
          "service": "service"
        }
      ]
    },
    "booking_id": "00000000-0000-0000-0000-000000000000",
    "task_type": "booking",
    "status": "pending",
    "assigned_to": "00000000-0000-0000-0000-000000000000",
    "assigned_to_name": "assigned_to_name",
    "notes": "notes",
    "job_report": "job_report",
    "scheduled_date": "scheduled_date",
    "scheduled_start_time": "scheduled_start_time",
    "scheduled_end_time": "scheduled_end_time",
    "created_at": "created_at",
    "started_at": "started_at",
    "completed_at": "completed_at",
    "cancelled_at": "cancelled_at",
    "next_booking": null,
    "access": "access",
    "public_token": "public_token"
  }
}

json

application/json

Auth Calendar