Push Customer Data

Early Access Preview. The customers API is currently in Alpha. We're actively developing it and seeking early feedback at [email protected]. Expect breaking changes as we refine the design.

• Request Parameters

• Response

Pushes customer data including resources like spaces, properties, rooms, users, etc.

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

customer_key String (Required)

Your unique identifier for the customer.

---

access_grants Array of Objects

List of access grants.

access_grant_key String

Your unique identifier for the access grant.

---

building_keys List

Building keys associated with the access grant.

---

common_area_keys List

Common area keys associated with the access grant.

---

ends_at Datetime

Ending date and time for the access grant.

---

facility_keys List

Facility keys associated with the access grant.

---

guest_key String

Guest key associated with the access grant.

---

listing_keys List

Listing keys associated with the access grant.

---

name String

Your name for this access grant resource.

---

preferred_code String

Preferred PIN code to use when creating access for this reservation.

---

property_keys List

Property keys associated with the access grant.

---

resident_key String

Resident key associated with the access grant.

---

room_keys List

Room keys associated with the access grant.

---

space_keys List

Space keys associated with the access grant.

---

starts_at Datetime

Starting date and time for the access grant.

---

tenant_key String

Tenant key associated with the access grant.

---

unit_keys List

Unit keys associated with the access grant.

---

user_identity_key String

User identity key associated with the access grant.

---

user_key String

User key associated with the access grant.

---

bookings Array of Objects

List of bookings.

booking_key String

Your unique identifier for the booking.

---

building_keys List

Building keys associated with the access grant.

---

common_area_keys List

Common area keys associated with the access grant.

---

ends_at Datetime

Ending date and time for the access grant.

---

facility_keys List

Facility keys associated with the access grant.

---

guest_key String

Guest key associated with the access grant.

---

listing_keys List

Listing keys associated with the access grant.

---

name String

Your name for this access grant resource.

---

preferred_code String

Preferred PIN code to use when creating access for this reservation.

---

property_keys List

Property keys associated with the access grant.

---

resident_key String

Resident key associated with the access grant.

---

room_keys List

Room keys associated with the access grant.

---

space_keys List

Space keys associated with the access grant.

---

starts_at Datetime

Starting date and time for the access grant.

---

tenant_key String

Tenant key associated with the access grant.

---

unit_keys List

Unit keys associated with the access grant.

---

user_identity_key String

User identity key associated with the access grant.

---

user_key String

User key associated with the access grant.

---

buildings Array of Objects

List of buildings.

building_key String

Your unique identifier for the building.

---

name String

Your display name for this location resource.

---

common_areas Array of Objects

List of shared common areas.

common_area_key String

Your unique identifier for the common area.

---

name String

Your display name for this location resource.

---

parent_site_key String

Your unique identifier for the site.

---

facilities Array of Objects

List of gym or fitness facilities.

facility_key String

Your unique identifier for the facility.

---

name String

Your display name for this location resource.

---

guests Array of Objects

List of guests.

email_address String

Email address associated with the user identity.

---

guest_key String

Your unique identifier for the guest.

---

name String

Your display name for this user identity resource.

---

phone_number String

Phone number associated with the user identity.

---

listings Array of Objects

List of property listings.

listing_key String

Your unique identifier for the listing.

---

name String

Your display name for this location resource.

---

properties Array of Objects

List of short-term rental properties.

name String

Your display name for this location resource.

---

property_key String

Your unique identifier for the property.

---

property_listings Array of Objects

List of property listings.

custom_metadata Record

Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application.

---

name String

Your display name for this location resource.

---

property_listing_key String

Your unique identifier for the property listing.

---

reservations Array of Objects

List of reservations.

building_keys List

Building keys associated with the access grant.

---

common_area_keys List

Common area keys associated with the access grant.

---

ends_at Datetime

Ending date and time for the access grant.

---

facility_keys List

Facility keys associated with the access grant.

---

guest_key String

Guest key associated with the access grant.

---

listing_keys List

Listing keys associated with the access grant.

---

name String

Your name for this access grant resource.

---

preferred_code String

Preferred PIN code to use when creating access for this reservation.

---

property_keys List

Property keys associated with the access grant.

---

reservation_key String

Your unique identifier for the reservation.

---

resident_key String

Resident key associated with the access grant.

---

room_keys List

Room keys associated with the access grant.

---

space_keys List

Space keys associated with the access grant.

---

starts_at Datetime

Starting date and time for the access grant.

---

tenant_key String

Tenant key associated with the access grant.

---

unit_keys List

Unit keys associated with the access grant.

---

user_identity_key String

User identity key associated with the access grant.

---

user_key String

User key associated with the access grant.

---

residents Array of Objects

List of residents.

email_address String

Email address associated with the user identity.

---

name String

Your display name for this user identity resource.

---

phone_number String

Phone number associated with the user identity.

---

resident_key String

Your unique identifier for the resident.

---

rooms Array of Objects

List of hotel or hospitality rooms.

name String

Your display name for this location resource.

---

parent_site_key String

Your unique identifier for the site.

---

room_key String

Your unique identifier for the room.

---

sites Array of Objects

List of general sites or areas.

name String

Your display name for this location resource.

---

site_key String

Your unique identifier for the site.

---

spaces Array of Objects

List of general spaces or areas.

name String

Your display name for this location resource.

---

space_key String

Your unique identifier for the space.

---

staff_members Array of Objects

List of staff members.

building_keys List

List of unique identifiers for the buildings the staff member is associated with.

---

common_area_keys List

List of unique identifiers for the common areas the staff member is associated with.

---

email_address String

Email address associated with the user identity.

---

facility_keys List

List of unique identifiers for the facilities the staff member is associated with.

---

listing_keys List

List of unique identifiers for the listings the staff member is associated with.

---

name String

Your display name for this user identity resource.

---

phone_number String

Phone number associated with the user identity.

---

property_keys List

List of unique identifiers for the properties the staff member is associated with.

---

property_listing_keys List

List of unique identifiers for the property listings the staff member is associated with.

---

room_keys List

List of unique identifiers for the rooms the staff member is associated with.

---

site_keys List

List of unique identifiers for the sites the staff member is associated with.

---

space_keys List

List of unique identifiers for the spaces the staff member is associated with.

---

staff_member_key String

Your unique identifier for the staff.

---

unit_keys List

List of unique identifiers for the units the staff member is associated with.

---

tenants Array of Objects

List of tenants.

email_address String

Email address associated with the user identity.

---

name String

Your display name for this user identity resource.

---

phone_number String

Phone number associated with the user identity.

---

tenant_key String

Your unique identifier for the tenant.

---

units Array of Objects

List of multi-family residential units.

name String

Your display name for this location resource.

---

parent_site_key String

Your unique identifier for the site.

---

unit_key String

Your unique identifier for the unit.

---

user_identities Array of Objects

List of user identities.

email_address String

Email address associated with the user identity.

---

name String

Your display name for this user identity resource.

---

phone_number String

Phone number associated with the user identity.

---

user_identity_key String

Your unique identifier for the user identity.

---

users Array of Objects

List of users.

email_address String

Email address associated with the user identity.

---

name String

Your display name for this user identity resource.

---

phone_number String

Phone number associated with the user identity.

---

user_key String

Your unique identifier for the user.

---

Response

Returns: void