Getting Started

We’ve made many tools available to developers. Follow the steps below to start building your first application using the API:

  • Register for a user account
  • Retrieve your API key.
  • Browse the documentation.
  • Join our community if you have any questions.


To access the API for v2 communities, use as the main URL.

Corporate Identifiers

For companies that already have existing identifiers for units & tenants, it’s possible to use the Corporate Identifiers as function arguments:

  • Use the corporateCommunityId parameter instead of the communityId parameter.
  • Use corporateUnitId parameter instead of the unit parameter.
  • Use corporateTenantId parameter instead of the residentId parameter.