Tenants

Get tenant counts

Returns the five headline tenant numbers for the company — total, active, added today, not yet invited, and invites in flight. The figures are cached for 15 minutes, so a tenant you just created may not be counted yet.

GET

https://api.portal.magicdoor.com/company-app/tenants/counts

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Response

200 · The counts.

totalTenantsinteger

Every tenant the company has, active or not.

activeTenantsinteger

Tenants that have not been deactivated.

newTenantsTodayinteger

Active tenants created since midnight in the company's timezone.

unInvitedTenantsinteger

Active tenants that have never been invited to the tenant portal and have no invite waiting to be sent.

sendingInvitesCountinteger

Tenants with a portal invite scheduled but not yet sent. Post-invite follow-up messages are not counted.

401 · The access token is missing, expired, or does not belong to a property manager.

Request

curl --request GET \
  --url 'https://api.portal.magicdoor.com/company-app/tenants/counts' \
  --header 'Authorization: Bearer <token>'

Response

{
  "totalTenants": 137,
  "activeTenants": 129,
  "newTenantsToday": 2,
  "unInvitedTenants": 14,
  "sendingInvitesCount": 3
}