get
https://api.elliemae.com/encompass/v3/externalUsers
Retrieve details about all external TPO users. Use query parameters to filter results.
Either orgId or TPO ID is mandatory while querying for the list of external users.
Usage Notes
The users that are returned depends on the current user type and persona. Review the scenarios below for more details:
| Scenario | Behaviour |
|---|---|
| Current user is external user. | User can see external users within the user's current org, and all child orgs if 'isRecursive' is True. If the user passes the query orgId parameter outside their org hierarchy, an empty result set is returned. |
| Current user is external user and has "sales rep/AE" persona. | User can see external users for organizations where they are added as a sales rep/AE. |
Known Issue
Support for orgId=0 is not yet production-ready and has a known performance issue when data is retrieved without pagination. This issue will be addressed in an upcoming release. In the meantime, when testing this feature (NOT FOR PRODUCTION USE), you must include pagination parameters in all API requests, with a page size no greater than 1,000.
© ICE Mortgage Technology, Inc. All rights reserved.