REST API
The REST API gives programmatic access to the core entities in Interact — people, pages, content and more. This section explains how the API works and walks through common tasks; the full endpoint list lives in the API Reference.
What you can do
Use the REST API to read and change data in Interact from your own applications and scripts: retrieve the people directory, work with pages and content, manage calendar events, and integrate Interact into wider workflows. If you want Interact to notify you when something happens rather than polling for changes, see Webhooks.
How requests work
Every request is made over HTTPS to your intranet's API domain and must be authenticated. In outline:
- You obtain a bearer token by exchanging an API key and secret created in Control Panel > Security.
- Each request sends that token in an
Authorization: Bearer {{access_token}}header, along with anX-Tenantheader identifying your tenant. - Requests and responses use JSON.
Note: The authentication method varies between Interact's APIs. The key-and-secret flow described here applies to the REST API; profile sources and Workplace Search connectors authenticate differently. For the credential each API uses and how to send it, see Authentication overview. Full endpoint-level authentication details will live in the API Reference.
To find the tenant and API URL your requests need, start with How to get API information.
Worked examples
- Authentication overview — which credential each API uses, how it is generated, and which header sends it.
- How to get API information — find the tenant GUID and API URL your requests need.
- Get a list of all users — example C# and PowerShell to retrieve the people directory.
- Use the API to log in and redirect to a page — example PHP that converts an API-authenticated user into a web-authenticated user.
- Calendar events API — create, read, update and delete calendar events and manage attendees.
Next steps
- New to the API? Read Authentication overview and How to get API information first, then try Get a list of all users.
- Browse every endpoint in the API Reference.