List conversations
Changed onLists 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.
Pass broadcast_id to list a broadcast's conversations, one per recipient, instead. The ones with a reply come first, latest reply first, then the ones still waiting for one. Each has replied set, and replied=true or replied=false returns only those. broadcast_id can't be combined with study_id or participant_id.
Results are paginated. Follow next for the following page, or stop when it is null.
Request
- Base URLhttps://api.prolific.com
- URLhttps://api.prolific.com/api/v1/conversations/
- AuthAPI key in header Authorization
Query parameters
List the conversations of this workspace instead of the caller's own. The caller must belong to the workspace.
Only return conversations about this study.
Only return conversations with this participant.
List this broadcast's conversations. It must have been sent from your account, or from the workspace given.
With broadcast_id, only return the conversations with a reply (true) or without one (false).
Page size. Defaults to 25, capped at 100.
Opaque token from a previous response's next link.
Response
A page of conversations
Changes
- info
added the new optional
queryrequest parameterbroadcast_id - info
added the new optional
queryrequest parameterreplied - info
added the optional property
//to the response with the status
- info
- warning
added the new
payment-timingenum value to the///response property for the response status - info
added the optional property
//to the response with the status
- warning