get https://api.elliemae.com/encompass/v3/users
Returns a list of Encompass internal users in the organization. You can use query parameters to filter the list of users.
This API endpoint added with the 24.2 release of Encompass.
Usage Notes
- Access Rights
- Only administrators (admin account, Super Administrator persona, and/or Administrator persona) or non-admin users with the Settings “Organizations/User” persona can retrieve user accounts.
- The calling user only has access to retrieve users within their same organization, or lower child organizations of their organization.
- To retrieve a list of organization ids, refer to V1 Get All Organizations.
- Use the ‘orgId’ parameter to specify the organization (folder) where the users are located. To retrieve users from the specified organization, as well as child organizations, use ‘isRecursive=true’. To retrieve all users across all organizations, use parameters ‘orgId=0’ to retrieve all users in the root organization, with ‘isRecursive=true’ to retrieve all child organizations under the root org.
- Filter parameters can be used to filter the list of users down even further, based on other user-level attributes. See filters parameter below for more information on the available filters.
- The entities parameter can be used to limit the data returned to just the specified entities. Default = ‘summary’. To retrieve all entities, use ‘entities=all’.
- The licenses entity is a fixed list of all 50 states and territories. When ‘entities=all’ or ‘entities=licenses’ is provided, you will receive the entire list of states and territories, including those that the user is not licensed in.
© ICE Mortgage Technology, Inc. All rights reserved.