Enterprise API tokens for working across every branch

What’s New

Available to enterprise accounts only. Enterprises can now connect a single integration (for example an LOS or point-of-sale system) to every branch at once, instead of creating one API token per branch.

Features

• Enterprise tokens. An enterprise owner or admin can create an Enterprise token in Settings → API Tokens while viewing the enterprise’s corporate team, and choose exactly what it may do.
• Find a loan officer in any branch. GET /api/partner/users?emailExact=<email> searches every branch and returns each user’s teams, so your integration knows which branch to send a lead to.
• List your branches. GET /api/partner/teams returns every branch in the enterprise, including whether each one has an active subscription.
• Send leads to a branch. POST /api/partner/events (or /people) with teamId creates or matches the contact in that branch and assigns it to the loan officer.
• Work in any branch. Any other Partner API call (contacts, tasks, notes, loans, contracts, and more) works on the branch named by teamId, limited to the permissions chosen for the token. Managing users, team settings and billing is never available to an enterprise token.

Improvements

• A new emailExact filter on GET /api/partner/users matches a whole email address. The existing email filter is a partial match, so [email protected] also finds [email protected].
• Enterprise tokens reject an assignedUserId that isn’t on the branch with a clear error, instead of assigning the lead to someone else.