API: Overview
Insight Public API
What is the Insight API?
The Insight Public API lets you connect Insight with your existing tools and systems. Whether you want to pull survey results into a BI dashboard, sync your organization structure from an HR system, or build custom reporting — the API gives you programmatic access to your Insight data.
Who is it for?
The API is designed for:
- IT teams integrating Insight into their existing tech stack
- HR analytics teams building custom dashboards and reports
- Integration partners connecting HR systems with Insight
- Developers building automations around employee engagement data
What can you do with it?
| Capability | Description |
|---|---|
| Organization data | Read your group structure (teams, departments, etc.) and group categories |
| User management | List, create, update, and delete users in bulk — keep your people data in sync with HR |
| Survey management | List surveys and track their status |
| Survey results | Access aggregated results per group, index, and question |
| Individual responses (customer surveys) | Pull individual response data for CX analysis, including free-text tonality |
| Indexes & questions | Retrieve your configured indexes and questions with localized names |
| Reference data | Look up attributes, freetext categories, group categories, and supported languages |
Key concepts
Insight organizes employee engagement data around a few core concepts:
- Groups — Your organizational units (teams, departments, offices, etc.), each belonging to a category
- Surveys — Questionnaires sent to employees, which can be one-time or recurring
- Indexes — Aggregated engagement themes (e.g., leadership, autonomy, meaningful work)
- Questions — Individual survey questions, either standard or custom to your organization
- Results — Aggregated scores per group, index, and question — always respecting anonymity thresholds
- Responses — Individual answers to a customer-experience (CX) survey, including free-text answers with tonality
Technical reference
For detailed endpoint documentation, request/response schemas, and the ability to try out API calls directly, see the interactive API reference →
Getting started
New to the API? See the Getting Started guide to make your first API call in minutes.