Skip to content
Developer Documentation

Returning Tenancies and Tenants

Question: How do we associate tenants with tenancies?

Answer: This can be achieved using the following process:

  1. Use one of the available Inventory endpoints to find a property or properties:
    • /inventory
    • /inventory/items
    • /inventory/{inventoryId}
    • /inventory/filter
    • /inventory/search
  2. Next, you can find Tenancies by Inventory here:
    • /inventory/{inventoryId}/tenancies
  3. Then, once you have the Tenancies, the Contacts (Tenants) are found using the call below:
    • /tenancies/{tenancyId}/tenantIds (You will match these contactIds with the next call).
  4. Now, to get the contact details you will use this endpoint which will return the details for the contactIds provided:
    • /contacts
  5. Finally, if you match the contactIds from /contacts with contactIds found in /tenancies/{tenancyId}/tenantIds, you will have your relationship.