Connect Buildium (`credentials: { clientId, clientSecret }`) or DoorLoop (`credentials: { token }`) for the organization. The key is checked with one read-only call to the system, then stored encrypted, replacing any earlier one; it is never returned. An owner's signed-in session in live mode only

post/v1/integrations/{system}/connect

Request

  • Base URL: https://api.evictionsapi.com
  • URL: https://api.evictionsapi.com/v1/integrations/{system}/connect
  • Auth: HTTP bearer

Path parameters

system'buildium' | 'doorloop' required

Request body

labelstring

Response

The stored connection.

system'buildium' | 'doorloop' required
labelstring required

The name the organization gave it; the system's name by default.

createdAtstring date-time required
lastUsedAtstring date-time nullable required
lastErrorstring nullable required

How the last search or pull failed (unauthorized, rate_limited, unavailable); null when it worked.

Changes

No recorded changes to this operation across all 1 revision of this API.