Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Owners

Get list of owners

Get list of owners

get/owners

Query parameters

skipnumber

Pagination start index

limitnumber

Limit amount of results per page

sortstring
Example:firstName lastName

Ordered list of field names to sort by, separated by spaces

qstring

Filter expression

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

paginationboolean

Paginated response

Response

OR

Example response

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