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:
The admin type can be determined 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.

Language
Credentials
Bearer
API Token
URL
Click Try It! to start a request and see the response here!