Skip to navigation

List conversations

View as MarkdownOpen in Claude

Lists the caller’s conversations, most recently updated first. A conversation is the thread between two members and carries a subject, topic and study where those have been set. Conversations that predate these fields return them as null.

Pass workspace_id to list a workspace’s conversations instead of the caller’s own. Pass study_id to only return conversations about that study, and participant_id to only return conversations with that participant. The two can be combined.

Results are paginated. Follow next for the following page, or stop when it is null.

Authentication

AuthorizationToken

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

Query parameters

workspace_idstringOptional
List the conversations of this workspace instead of the caller's own. The caller must belong to the workspace.
study_idstringOptional
Only return conversations about this study.
participant_idstringOptional
Only return conversations with this participant.
limitintegerOptional
Page size. Defaults to 25, capped at 100.
cursorstringOptional

Opaque token from a previous response’s next link.

Response

A page of conversations
nextstring or null
URL of the next page, or null on the last page.
resultslist of objects

Errors

4XX
Client Request Error
503
Service Unavailable Error
504
Gateway Timeout Error