PropertyMembers

List property invitations

GET

/v1/properties/{id}/invitations

List property invitations › path Parameters

id

string · required

Property id

List property invitations › Responses

Invitations for the property, including expired and exhausted ones

PropertyInvitationsResponse

PropertyInvitation[] · required

Create crew invitation

POST

/v1/properties/{id}/invitations

Generates an invitation token (optionally bound to a specific email) that grants the invitee crew access with the chosen level when accepted. When an email is provided, the invitee receives an invitation email rendered in the request's locale.

Create crew invitation › path Parameters

id

string · required

Property id

Create crew invitation › Request Body

CreatePropertyInvitationRequest

email

string | null

maxUses

integer | null

expiresAt

string | null

accessLevel

string

locale

string · enum

Enum values:

Create crew invitation › Responses

The created invitation. Expires seven days after creation.

PropertyInvitation

id

string · uuid · required

propertyId

string · uuid · required

token

string · required

uses

integer · required

createdAt

string · required

accessLevel

string · required

locale

string · enum · required

Enum values:

email

string | null

maxUses

integer | null

expiresAt

string | null

acceptedAt

string | null

POST/v1/properties/{id}/invitations

curl /v1/properties/:id/invitations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "email": "email",
  "maxUses": 0,
  "expiresAt": "expiresAt",
  "accessLevel": "accessLevel",
  "locale": "en"
}'

Example Request Body

{
  "email": "email",
  "maxUses": 0,
  "expiresAt": "expiresAt",
  "accessLevel": "accessLevel",
  "locale": "en"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "propertyId": "00000000-0000-0000-0000-000000000000",
  "email": "email",
  "token": "token",
  "maxUses": 0,
  "uses": 0,
  "expiresAt": "expiresAt",
  "createdAt": "createdAt",
  "acceptedAt": "acceptedAt",
  "accessLevel": "accessLevel",
  "locale": "en"
}

json

application/json

List property members (owners and crew)

GET

/v1/properties/{id}/crew

List property members (owners and crew) › path Parameters

id

string · required

Property id

List property members (owners and crew) › Responses

Property members (owners and crew) with their access levels and services, plus the property's default cleaner id

PropertyMembersResponse

PropertyMember[] · required

default_cleaner_id

string | null · uuid

Remove crew member

DELETE

/v1/properties/{id}/crew/{userId}

Remove crew member › path Parameters

id

string · required

Property id

userId

string · required

User id of the crew member to remove

Remove crew member › Responses

Crew member removed

No data returned

Update crew member access

PATCH

/v1/properties/{id}/crew/{userId}

Update crew member access › path Parameters

id

string · required

Property id

userId

string · required

User id of the crew member to update

Update crew member access › Request Body

UpdatePropertyMemberRequest

accessLevel

string · required

Update crew member access › Responses

Access level updated

No data returned

Revoke invitation

DELETE

/v1/invitations/{id}

Revoke invitation › path Parameters

id

string · required

Invitation id

Revoke invitation › Responses

Invitation deleted

No data returned

Accept crew invitation

POST

/v1/invitations/{token}/accept

Grants the authenticated caller crew access to the invitation's property at the invitation's access level and increments the invitation's usage counter.

Accept crew invitation › path Parameters

token

string · required

Invitation token

Accept crew invitation › Responses

Invitation accepted; the caller now has access to the property

AcceptInvitationResponse

propertyId

string · uuid · required

propertyName

string · required

Properties SmartLocks

Kasify API

PropertyMembers

List property invitations

GET

/v1/properties/{id}/invitations

List property invitations › path Parameters

id

string · required

Property id

List property invitations › Responses

Invitations for the property, including expired and exhausted ones

PropertyInvitationsResponse

PropertyInvitation[] · required

Create crew invitation

POST

/v1/properties/{id}/invitations

Create crew invitation › path Parameters

id

string · required

Property id

Create crew invitation › Request Body

CreatePropertyInvitationRequest

email

string | null

maxUses

integer | null

expiresAt

string | null

accessLevel

string

locale

string · enum

Enum values:

Create crew invitation › Responses

The created invitation. Expires seven days after creation.

PropertyInvitation

id

string · uuid · required

propertyId

string · uuid · required

token

string · required

uses

integer · required

createdAt

string · required

accessLevel

string · required

locale

string · enum · required

Enum values:

email

string | null

maxUses

integer | null

expiresAt

string | null

acceptedAt

string | null

POST/v1/properties/{id}/invitations

curl /v1/properties/:id/invitations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "email": "email",
  "maxUses": 0,
  "expiresAt": "expiresAt",
  "accessLevel": "accessLevel",
  "locale": "en"
}'

Example Request Body

{
  "email": "email",
  "maxUses": 0,
  "expiresAt": "expiresAt",
  "accessLevel": "accessLevel",
  "locale": "en"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "propertyId": "00000000-0000-0000-0000-000000000000",
  "email": "email",
  "token": "token",
  "maxUses": 0,
  "uses": 0,
  "expiresAt": "expiresAt",
  "createdAt": "createdAt",
  "acceptedAt": "acceptedAt",
  "accessLevel": "accessLevel",
  "locale": "en"
}

json

application/json

List property members (owners and crew)

GET

/v1/properties/{id}/crew

List property members (owners and crew) › path Parameters

id

string · required

Property id

List property members (owners and crew) › Responses

Property members (owners and crew) with their access levels and services, plus the property's default cleaner id

PropertyMembersResponse

PropertyMember[] · required

default_cleaner_id

string | null · uuid

Remove crew member

DELETE

/v1/properties/{id}/crew/{userId}

Remove crew member › path Parameters

id

string · required

Property id

userId

string · required

User id of the crew member to remove

Remove crew member › Responses

Crew member removed

No data returned

Update crew member access

PATCH

/v1/properties/{id}/crew/{userId}

Update crew member access › path Parameters

id

string · required

Property id

userId

string · required

User id of the crew member to update

Update crew member access › Request Body

UpdatePropertyMemberRequest

accessLevel

string · required

Update crew member access › Responses

Access level updated

No data returned

Revoke invitation

DELETE

/v1/invitations/{id}

Revoke invitation › path Parameters

id

string · required

Invitation id

Revoke invitation › Responses

Invitation deleted

No data returned

Accept crew invitation

POST

/v1/invitations/{token}/accept

Grants the authenticated caller crew access to the invitation's property at the invitation's access level and increments the invitation's usage counter.

Accept crew invitation › path Parameters

token

string · required

Invitation token

Accept crew invitation › Responses

Invitation accepted; the caller now has access to the property

AcceptInvitationResponse

propertyId

string · uuid · required

propertyName

string · required

Properties SmartLocks