v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Owners

Get owner

get/owners/{ownerId}

Path parameters

ownerIdstring required

Owner id

Query parameters

fieldsstring[]

Selection of fields, separated by space. If fields are not provided, the response will return with all fields. Possible values depend on the response type. For example, owners: _id firstName lastName fullName email address phone picture notes ownersPortalSettings listings locale active createdAt

Response

_idstring required

Owner id

accountIdstring required

Account id

guestIdstring

Guest id used for owner reservations

guestIdsstring[]

Array of friends & family guests ids for this owner

listingsobject

Array of listings ids

emailstring required

firstNamestring required

lastNamestring required

fullNamestring

notesstring

addressstring

phonestring

activeboolean

localestring

createdAtstring date-time

deletedAtstring date-time

allowReservationsboolean

Deprecated. Use ownersPortalSettings.allowReservations

showReservationTooltipsboolean

Deprecated. Use ownersPortalSettings.allowReservations

birthdaystring date-time

anniversarystring date-time

hasLoggedInAtLeastOnceboolean

Information about first log in

rolesstring

Authorized user role

Example response

{
  "_id": "611d02b7c9c54b01736ae01d",
  "accountId": "611cf837c9c54b01736ae01c",
  "guestId": "611cf837c9c54b01736ae01c",
  "guestIds": [
    "611cf837c9c54b01736ae01c"
  ],
  "email": "example@email.com",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "locale": "en-US",
  "roles": "owner"
}