Kasify
ENES
  • Documentation
  • Documentación
  • Developers
  • API Reference
Information
AccessCodes
    Create digital access codes for a bookingpostRevoke a digital access codedelete
Account
    Get the user's accountgetUpdate the user's accountput
Auth
    Register the authenticated userpost
Bookings
    Get the current booking for a propertygetList bookings for a propertygetCreate a booking for a propertypostList bookings across all properties the caller can accessgetGet a booking by idgetUpdate a bookingpatch
Calendar
    List calendar events for a propertygetList upcoming calendar events across accessible propertiesget
Checkin
    Get the guest check-in snapshot for a bookinggetRegister a guest on a bookingpost
Geo
    Search countriesgetSearch provincesgetSearch citiesget
Guests
    List guests registered under the caller's accountget
Integrations
    List all integrations configured for the accountgetList integrations of a specific typegetCreate an integration of a specific typepostUpdate an integrationputDelete an integrationdeleteList Nuki smart locks reachable through an integrationgetList Unifi doors reachable through an integrationget
Properties
    List properties accessible to the callergetCreate a propertypostGet a property by idgetUpdate a propertyputDelete a propertydeleteUpload a cover image for a propertypostRemove the cover image for a propertydelete
PropertyMembers
    List invitations for a propertygetCreate a crew invitation for a propertypostList crew members for a propertygetRemove a crew member from a propertydeleteUpdate a crew member's access levelpatchRevoke an invitationdeleteAccept a crew invitationpost
SmartLocks
    List smart locks for a property with live statusgetAdd a smart lock to a propertypostRemove a smart lock from a propertydelete
Tasks
    List tasksgetCreate a taskpostGet a task by idgetDelete a taskdeleteUpdate a taskpatchStart a taskpostComplete a taskpostList tasks for a propertygetGet a task by public token (no auth)get
Timeline
    Upcoming timeline grouped by daygetPaginated activity feedget
Users
    List every user (admin only)get
Schemas
Kasify API
Kasify API

Schemas


PropertyMember

id
​string · uuid · required
name
​string · required
last_name
​string · required
email
​string · required
access_level
​string · required
service
​string | null

Calendar

channel
​string · required
url
​string · required
syncIntervalMinutes
​integer · required
lastSyncAt
​string | null · date
lastError
​string | null

SmartLockInfo

id
​string · uuid · required
vendor
​string · required
name
​string · required

Property

name
​string · required
id
​string | null · uuid
account_id
​string | null · uuid
address
​string | null
city
​string | null
zip_code
​string | null
country
​string | null
ses_establishment_code
​string | null
ses_establishment_type
​string | null
has_internet
​boolean | null
rooms_count
​integer | null
​
cover_image_url
​string | null
role
​string | null
​Calendar[]
​SmartLockInfo[]
​PropertyMember[]

PropertiesResponse

​Property[] · required
page
​integer | null
size
​integer | null
total
​integer | null

NewPropertyRequest

name
​string · required
address
​string · required
city
​string · required
zip_code
​string · required
airbnb_ical_url
​string | null
default_cleaner_id
​string | null · uuid
ses_establishment_code
​string | null
ses_establishment_type
​string | null
has_internet
​boolean | null
rooms_count
​integer | null

FileResponse

id
​string · uuid · required
url
​string · required
original_filename
​string · required
content_type
​string · required
size_bytes
​integer · required

BookingInfo

channelId
​string | null

TaskInfo

id
​string · uuid · required
status
​string · enum · required
Enum values:
pending
in_progress
completed
assignedTo
​string | null · uuid
assignedToName
​string | null

CalendarEvent

propertyId
​string · uuid · required
from
​string · date · required
to
​string · date · required
type
​string · enum · required
Enum values:
booking
cleaning
maintenance
block
createdAt
​string · date · required
updatedAt
​string · date · required
id
​string | null · uuid
​
​

CalendarResponse

​CalendarEvent[] · required
page
​integer | null
size
​integer | null
total
​integer | null

AccessCode

id
​string · uuid · required
access_code
​string · required
smartlock_id
​string · uuid · required
smartlock_name
​string · required

Country

id
​string · uuid · required
name
​string · required
name_es
​string · required
alpha_2
​string · required
alpha_3
​string · required

Province

id
​string · uuid · required
country_id
​string · uuid · required
name
​string · required
code_iso_3166_2
​string · required
ine_code_pro
​string · required

City

id
​string · uuid · required
country_id
​string · uuid · required
province_id
​string · uuid · required
name
​string · required
ine_code
​string · required
ine_code_mun
​string · required

Guest

id
​string · uuid · required
booking_id
​string · uuid · required
property_id
​string · uuid · required
first_name
​string · required
last_name
​string · required
second_last_name
​string | null
​
date_of_birth
​string | null
sex
​string | null
​
​
​
residence_city_name
​string | null
residence_address
​string | null
residence_postal_code
​string | null
document_type
​string | null
document_number
​string | null
document_support_number
​string | null
email
​string | null
phone
​string | null
phone_prefix
​string | null
relationship_code
​string | null

Task

id
​string · uuid · required
​Property · required
task_type
​string · enum · required
Enum values:
booking
cleaning
maintenance
block
status
​string · enum · required
Enum values:
pending
in_progress
completed
assigned_to
​string · uuid · required
assigned_to_name
​string · required
scheduled_date
​string · required
scheduled_start_time
​string · required
scheduled_end_time
​string · required
created_at
​string · required
booking_id
​string | null · uuid
notes
​string | null
job_report
​string | null
started_at
​string | null
completed_at
​string | null
cancelled_at
​string | null
​
access
​string | null
public_token
​string | null

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
​

BookingsResponse

​Booking[] · required
page
​integer | null
size
​integer | null
total
​integer | null

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

PropertyInfo

name
​string · required
address
​string · required
city
​string · required
zip_code
​string · required
cover_image_url
​string | null

CheckinResponse

​PropertyInfo · required
from
​string · required
to
​string · required
guests_number
​integer · required
booking_code
​string · required
​Guest[] · required
checkin_completed
​boolean · required
checkin_closed
​boolean · required

GuestRegistrationRequest

first_name
​string · required
last_name
​string · required
nationality_country_code
​string · required
date_of_birth
​string · required
sex
​string · required
second_last_name
​string | null
document_type
​string | null
document_number
​string | null
document_support_number
​string | null
residence_address
​string | null
residence_country_code
​string | null
residence_province_id
​string | null · uuid
residence_city_id
​string | null · uuid
residence_city
​string | null
residence_postal_code
​string | null
phone_prefix
​string | null
phone
​string | null
email
​string | null

nuki

id
​string | null · uuid

ses_hospedajes

arrendador_code
​string · required
ses_username
​string · required
environment
​string · required
enabled
​boolean · required
id
​string | null · uuid

unifi

unifi_username
​string · required
unifi_console_url
​string · required
id
​string | null · uuid

IntegrationItem

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object
type = object · requires: arrendador_code, ses_username, environment +1 more
type = object · requires: unifi_username, unifi_console_url
Properties for nuki:
nuki
id
​string | null · uuid

IntegrationsResponse

​IntegrationItem[] · required

AssignedProperty

property_id
​string · uuid · required
property_name
​string · required
smartlock_record_id
​string · uuid · required

AvailableNukiSmartlock

smartlock_id
​integer · required
name
​string · required
battery_critical
​boolean · required
lock_state
​integer | null
battery_charge
​integer | null
offline
​boolean
​

NukiSmartlocksResponse

​AvailableNukiSmartlock[] · required
nuki_status
​string · enum
Enum values:
online
unauthorized
unreachable

UnifiSmartlock

floor_id
​string · required
door_id
​string · required
name
​string · required
​

UnifilocksResponse

​UnifiSmartlock[] · required

NukiSmartlock

id
​string · uuid · required
nuki_smartlock_id
​string · required

eu.kasify.model.api.UnifiSmartlock

id
​string · uuid · required
floor_id
​string · required
door_id
​string · required

SmartLock

id
​string · uuid · required
vendor
​string · required
name
​string · required
property_id
​string · uuid · required
​
​
lock_state
​integer | null
battery_level
​integer | null
battery_charging
​boolean | null
offline
​boolean

AddSmartlockRequest

name
​string · required
nuki_smartlock_id
​string | null
nuki_integration_id
​string | null · uuid
unifi_floor_id
​string | null
unifi_door_id
​string | null

BookingAccessCode

id
​string · uuid · required
booking_id
​string · uuid · required
smartlock_id
​string · uuid · required
access_code
​string · required
code_start_datetime
​string · required
code_end_datetime
​string · required
created_at
​string · required
updated_at
​string · required
vendor_code_id
​string | null
deleted_at
​string | null
​

KeysResponse

accessCode
​string · required
​BookingAccessCode[] · required
​SmartLockInfo[] · required

ComponentHealth

status
​string · required
​object

HealthResponse

status
​string · required
timestamp
​string · required
​object · required

User

id
​string · uuid · required
account_id
​string · uuid · required
name
​string · required
last_name
​string · required
email
​string · required
created_at
​string | null

Account

id
​string · uuid · required
account_id
​string · uuid · required
name
​string · required
last_name
​string · required
email
​string · required

UpdateAccountRequest

name
​string · required
last_name
​string · required

SignupRequest

name
​string · required
last_name
​string · required

CreatePropertyInvitationRequest

email
​string | null
maxUses
​integer | null
expiresAt
​string | null
accessLevel
​string

PropertyInvitation

id
​string · uuid · required
propertyId
​string · uuid · required
token
​string · required
uses
​integer · required
createdAt
​string · required
accessLevel
​string · required
email
​string | null
maxUses
​integer | null
expiresAt
​string | null
acceptedAt
​string | null

PropertyInvitationsResponse

​PropertyInvitation[] · required

PropertyMembersResponse

​PropertyMember[] · required

UpdatePropertyMemberRequest

accessLevel
​string · required

AcceptInvitationResponse

propertyId
​string · uuid · required
propertyName
​string · required

CreateTaskRequest

property_id
​string · uuid · required
task_type
​string · enum · required
Enum values:
booking
cleaning
maintenance
block
scheduled_date
​string · required
scheduled_start_time
​string · required
scheduled_end_time
​string · required
booking_id
​string | null · uuid
assigned_to
​string | null · uuid
notes
​string | null

TasksResponse

​Task[] · required
page
​integer | null
size
​integer | null
total
​integer | null

UpdateTaskRequest

assigned_to
​string | null · uuid
notes
​string | null
status
​string | null · enum
Enum values:
pending
in_progress
completed
job_report
​string | null

GuestsResponse

​Guest[] · required
page
​integer | null
size
​integer | null
total
​integer | null

CountriesResponse

​Country[] · required
page
​integer | null
size
​integer | null
total
​integer | null

ProvincesResponse

​Province[] · required
page
​integer | null
size
​integer | null
total
​integer | null

CitiesResponse

​City[] · required
page
​integer | null
size
​integer | null
total
​integer | null
On this page
  • PropertyMember
  • Calendar
  • SmartLockInfo
  • Property
  • PropertiesResponse
  • NewPropertyRequest
  • FileResponse
  • BookingInfo
  • TaskInfo
  • CalendarEvent
  • CalendarResponse
  • AccessCode
  • Country
  • Province
  • City
  • Guest
  • Task
  • Booking
  • BookingsResponse
  • BookingData
  • PropertyInfo
  • CheckinResponse
  • GuestRegistrationRequest
  • nuki
  • ses_hospedajes
  • unifi
  • IntegrationItem
  • IntegrationsResponse
  • AssignedProperty
  • AvailableNukiSmartlock
  • NukiSmartlocksResponse
  • UnifiSmartlock
  • UnifilocksResponse
  • NukiSmartlock
  • eu.kasify.model.api.UnifiSmartlock
  • SmartLock
  • AddSmartlockRequest
  • BookingAccessCode
  • KeysResponse
  • ComponentHealth
  • HealthResponse
  • User
  • Account
  • UpdateAccountRequest
  • SignupRequest
  • CreatePropertyInvitationRequest
  • PropertyInvitation
  • PropertyInvitationsResponse
  • PropertyMembersResponse
  • UpdatePropertyMemberRequest
  • AcceptInvitationResponse
  • CreateTaskRequest
  • TasksResponse
  • UpdateTaskRequest
  • GuestsResponse
  • CountriesResponse
  • ProvincesResponse
  • CitiesResponse