Help center
Read studies through the API
Connect an integration using a key and read scopes.
What it does
Query authorized data outside the UXTap interface.
When to use it
To bring studies and results into your own integration.
Before you begin
- Administrator permission and required authentication
- A server-side secret store
See how it works
Real screens with demo data
1 / 4
01
Open API for integrations
In Settings, open API for integrations. Read the OpenAPI contract to choose required data and filters.
- /openapi.json
An example to try
Query studies using read:studies and follow the next-page cursor.
What you see in results
- A key with defined expiry and scopes
- Read queries and monitorable usage
Avoid these mix-ups
- The API is read-only and does not use cookies or URL keys.
- read:sessions may include answer text; grant it only if needed.
- Changing a password or signing out all devices may revoke keys.