V3 Get Internal User Profile

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.
• You can retrieve your own profile by using the alias, ‘me’. Replace the userId with the ‘me’ alias.
• Default = ‘summary’. To retrieve all entities, use ‘entities=all’.
  • When entities parameter is passed with one or more values: The response will be summary + the other requested entities. Summary entity is always provided.
• If both the ‘view’ parameter and the ‘entities’ parameter are included in the request, the response will be an intersection of properties that exist in both responses. The best practice is to use either the ‘view’ parameter, or ‘entities’ parameter, but not both in the same request
• 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.