Site
Reference for the site endpoints of the Interact REST API.
Note: All endpoints require authentication and an
X-Tenantheader. See Authentication overview and How to get API information. Paths are relative to your intranet's API base URL. An Access line appears where an endpoint needs more than a signed-in user.
Endpoints on this page
GET /api/site
Returns a paged list of sites
🔒Access — Requires the ADMIN_MANAGE_SITES permission
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
title |
query | string | No | |
offset |
query | integer (int32) | No | |
limit |
query | integer (int32) | No | |
orderBy |
query | string | No | |
sortDirection |
query | string | No | Allowed values: Ascending, Descending |
Responses
| Status | Body |
|---|---|
| 200 | object |
POST /api/site/{id}/activation
Activates or deactivates the site
🔒Access — Requires the ADMIN_MANAGE_SITES permission
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | integer (int32) | Yes |
Request body
trueNo documented fields.
Responses
| Status | Body |
|---|---|
| 200 | object |
Section: REST API