HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Admin / Read

Get administrator details by ID.

Returns administrator information including organizational context (if applicable), role, and optionally permissions.

Admin types:
adminType holds the type of the administrator. The organization is also identified by which optional ID field is present:

  • partnerId - Admin belongs to a partner organization
  • subOperatorId - Admin belongs to a sub-operator organization
  • installationAndMaintenanceCompanyId - Admin belongs to an I&M company
  • None of the above - Operator-level administrator

SSO field:
The externalSsoId field is present when the administrator has SSO authentication enabled.

Permissions include:
Use ?include[]=permissions to include the administrator's permissions in the response.

For a partner or sub-operator API token, this endpoint returns 404 Not Found if the requested resource or its parent is outside the token's scope. If the target is visible to the token but the token lacks the required read permission, it returns 403 Forbidden.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Administrator ID

Query Params
include
array of strings
include
Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json