Get Sites

GET /engage/sites

This API returns a list of sites that the requester has access to and can only be accessed by a partner account type. ENGAGE managed login types are not able to access this API.

Authorization

Basic Authentication, must be a partner managed account type

Response

HTTP status code 200

• OK

Body

Type: application/json

Response Parameters

Type: application/json

• SiteReference = string

  • Site reference identifier

• Name = string

  • Friendly name of the site

• IsEngageManaged = boolean

  • If the site access management uses ENGAGE. It is most common for an externally managed site, that this is false.

Example response body:

[{"SiteReference":"b0dd6808-b37f-4615-99e6-803ed5654e35","Name":"Default
site","IsEngageManaged":false},{"SiteReference":"91dc57fe-5e71-46fd-adc4-0aa28fca861d","Name":"ACME
Hammers","IsEngageManaged":true},{"SiteReference":"d3eb2914-2438-404b-9d4a-7688b5ff1e63","Name":"ACME
Saws","IsEngageManaged":false}]