Get Operators

GET /engage/sites/{siteReference}/operators

This API returns a list of operators that have access to a given site and their access privilege (role) and can only be accessed with a partner account type. ENGAGE managed login types are not able to access this API.

Authentication

Basic Authentication, must be a partner managed account type

Response

HTTP status code 200

• OK

Body

Type: application/json

Response Parameters

Type: application/json

• Username = string

  • Email address of the given user

• Role = string

  • The type of role that will be included in the invitation. Valid options:

    • “Operator”

    • “Manager”

    • “SiteAdmin”

• FirstName = string

• LastName = string

• OperatorId = string

  • OperatorId is a unique 64 bit integer value on a per site basis. Therefore, the same user will have a different OperatorId for each site: they are an “Operator”, “Manager”, or “SiteAdmin”

Example response body:

[{"UserName":"primary\@security.com","Role":"SiteAdmin","FirstName":"John","LastName":"Smith",”OperatorId”:14380},
{"UserName":"manager\@security.com","Role":"Manager","FirstName":"Jane","LastName":"Doe",”OperatorId”:14381},
{"UserName":"operator\@security.com","Role":"Operator","FirstName":"Tim","LastName":"Jones",”OperatorId”:14382}]