Read studies through the API

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

Guided tutorial

Read each step and choose Play to hear the explanation while following the screen.

1 / 4

Open API for integrations

What to doRead contract

Real screens with demo data

Highlighted area in detail

Open Settings and find API for integrations. Click OpenAPI contract to review read endpoints, filters and pagination. To list studies, find GET /api/v1/studies and confirm the data needed before creating a key.

/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.

Export data and present findings

Choose CSV, report or presentation for each audience.

Manage team, account and comments

Provide suitable access and discuss evidence in context.

Configure consent and care for data

Review what research collects and how long it stays available.