v1

latestOpenAPI 3.1.02026-08-067019120.8 KB
Interviews

List interview sessions on the system

Returns a filterable, paginated list of all interview sessions on the system. Requires admin, advocate, or the access_sessions permission.

get/api/interviews

Query parameters

secretstring

Decryption secret to include encrypted session data.

istring

Filter by interview filename.

sessionstring

Filter by session ID.

querystring

Session query string for additional filtering.

tagstring

Filter by tag.

include_dictionary0 | 1

Set to 1 to include the interview answers in the response.

next_idstring

Pagination token.

Response

Paginated list of interview sessions.

next_idstring nullable required

Opaque token to pass as next_id to retrieve the next page. null when no further pages exist.