Download Postman Collection
API Reference

V3 Get External Organizations

get https://api.elliemae.com/encompass/v3/settings/externalOrganizations/tpos

Retrieves a list of external organization summary details and child organization hierarchy.

This API endpoint added with the 24.2 release of Encompass.

Usage Notes

  • For the entities query parameter, the API supports including multiple entities in a single call via a comma-separated list of supported entities.

  • The organizations that are returned depends on the current user type and persona. Review the scenarios below for more details:

    ScenarioBehavior
    Current user is external user.User can see external orgs in its hierarchy, above its current org, and all child orgs if 'isRecursive' is True.
    Current user is external user and has "sales rep/AE" persona.User can see external orgs in which current logged-in user is added as sales rep/AE.
    Current user is internal user and has "sales rep/AE" persona.User can see external orgs for the organizations for which they are assigned as "sales rep/AE".
Language
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use