Calendar

List property calendar events

GET

/v1/properties/{id}/calendar

Returns bookings, cleaning tasks, and other calendar events for the property within the [from, to] window (defaults to today through one month from today). Contractors see only events tied to tasks assigned to them.

List property calendar events › path Parameters

id

string · required

Property id

List property calendar events › query Parameters

from

string

Window start date, inclusive (YYYY-MM-DD). Optional, defaults to today.

to

string

Window end date, inclusive (YYYY-MM-DD). Optional, defaults to one month after from. Window must not exceed 366 days.

List property calendar events › Responses

Calendar events for the property within the window

PropertyCalendarEventsResponse

CalendarEvent[] · required

from

string · date · required

to

string · date · required

GET/v1/properties/{id}/calendar

curl /v1/properties/:id/calendar \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "events": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "propertyId": "00000000-0000-0000-0000-000000000000",
      "from": "from",
      "to": "to",
      "type": "booking",
      "createdAt": "2024-08-25",
      "updatedAt": "2024-08-25",
      "booking": {
        "id": "00000000-0000-0000-0000-000000000000",
        "channelId": "channelId",
        "guest_first_name": "guest_first_name",
        "guest_last_name": "guest_last_name",
        "adults_count": 0,
        "children_count": 0,
        "infants_count": 0,
        "channel": "channel"
      },
      "task": {
        "id": "00000000-0000-0000-0000-000000000000",
        "task_type": "task_type",
        "status": "pending",
        "assigned_to": "00000000-0000-0000-0000-000000000000",
        "assigned_to_name": "assigned_to_name"
      }
    }
  ],
  "from": "2024-08-25",
  "to": "2024-08-25"
}

json

application/json

List calendar events grouped by property

GET

/v1/calendar

Returns the caller's accessible properties, with each property's bookings and tasks for the requested date window (defaults to today through one month from today). Contractor properties only include events tied to the caller's assigned tasks.

List calendar events grouped by property › query Parameters

from

string

Window start date, inclusive (YYYY-MM-DD). Optional, defaults to today.

to

string

Window end date, inclusive (YYYY-MM-DD). Optional, defaults to one month after from. Window must not exceed 366 days.

List calendar events grouped by property › Responses

Properties accessible to the caller, each with its events for the window

CalendarResponse

PropertyCalendar[] · required

from

string · date · required

to

string · date · required

GET/v1/calendar

curl /v1/calendar \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "properties": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "events": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "propertyId": "00000000-0000-0000-0000-000000000000",
          "from": "from",
          "to": "to",
          "type": "booking",
          "createdAt": "2024-08-25",
          "updatedAt": "2024-08-25",
          "booking": {
            "id": "00000000-0000-0000-0000-000000000000",
            "channelId": "channelId",
            "guest_first_name": "guest_first_name",
            "guest_last_name": "guest_last_name",
            "adults_count": 0,
            "children_count": 0,
            "infants_count": 0,
            "channel": "channel"
          },
          "task": {
            "id": "00000000-0000-0000-0000-000000000000",
            "task_type": "task_type",
            "status": "pending",
            "assigned_to": "00000000-0000-0000-0000-000000000000",
            "assigned_to_name": "assigned_to_name"
          }
        }
      ]
    }
  ],
  "from": "2024-08-25",
  "to": "2024-08-25"
}

json

application/json

Bookings Checkin

Kasify API

Calendar

List property calendar events

GET

/v1/properties/{id}/calendar

List property calendar events › path Parameters

id

string · required

Property id

List property calendar events › query Parameters

from

string

Window start date, inclusive (YYYY-MM-DD). Optional, defaults to today.

to

string

Window end date, inclusive (YYYY-MM-DD). Optional, defaults to one month after from. Window must not exceed 366 days.

List property calendar events › Responses

Calendar events for the property within the window

PropertyCalendarEventsResponse

CalendarEvent[] · required

from

string · date · required

to

string · date · required

GET/v1/properties/{id}/calendar

curl /v1/properties/:id/calendar \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "events": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "propertyId": "00000000-0000-0000-0000-000000000000",
      "from": "from",
      "to": "to",
      "type": "booking",
      "createdAt": "2024-08-25",
      "updatedAt": "2024-08-25",
      "booking": {
        "id": "00000000-0000-0000-0000-000000000000",
        "channelId": "channelId",
        "guest_first_name": "guest_first_name",
        "guest_last_name": "guest_last_name",
        "adults_count": 0,
        "children_count": 0,
        "infants_count": 0,
        "channel": "channel"
      },
      "task": {
        "id": "00000000-0000-0000-0000-000000000000",
        "task_type": "task_type",
        "status": "pending",
        "assigned_to": "00000000-0000-0000-0000-000000000000",
        "assigned_to_name": "assigned_to_name"
      }
    }
  ],
  "from": "2024-08-25",
  "to": "2024-08-25"
}

json

application/json

List calendar events grouped by property

GET

/v1/calendar

List calendar events grouped by property › query Parameters

from

string

Window start date, inclusive (YYYY-MM-DD). Optional, defaults to today.

to

string

Window end date, inclusive (YYYY-MM-DD). Optional, defaults to one month after from. Window must not exceed 366 days.

List calendar events grouped by property › Responses

Properties accessible to the caller, each with its events for the window

CalendarResponse

PropertyCalendar[] · required

from

string · date · required

to

string · date · required

GET/v1/calendar

curl /v1/calendar \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "properties": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "events": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "propertyId": "00000000-0000-0000-0000-000000000000",
          "from": "from",
          "to": "to",
          "type": "booking",
          "createdAt": "2024-08-25",
          "updatedAt": "2024-08-25",
          "booking": {
            "id": "00000000-0000-0000-0000-000000000000",
            "channelId": "channelId",
            "guest_first_name": "guest_first_name",
            "guest_last_name": "guest_last_name",
            "adults_count": 0,
            "children_count": 0,
            "infants_count": 0,
            "channel": "channel"
          },
          "task": {
            "id": "00000000-0000-0000-0000-000000000000",
            "task_type": "task_type",
            "status": "pending",
            "assigned_to": "00000000-0000-0000-0000-000000000000",
            "assigned_to_name": "assigned_to_name"
          }
        }
      ]
    }
  ],
  "from": "2024-08-25",
  "to": "2024-08-25"
}

json

application/json

Bookings Checkin