messages

List conversations

Changed on

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.

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.

get/api/v1/conversations/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/conversations/
  • Auth
    API key in header Authorization

Query parameters

workspace_idstring

List the conversations of this workspace instead of the caller's own. The caller must belong to the workspace.

study_idstring

Only return conversations about this study.

participant_idstring

Only return conversations with this participant.

broadcast_idstring

List this broadcast's conversations. It must have been sent from your account, or from the workspace given.

repliedboolean

With broadcast_id, only return the conversations with a reply (true) or without one (false).

limitinteger

Page size. Defaults to 25, capped at 100.

cursorstring

Opaque token from a previous response's next link.

Response

A page of conversations

nextstring nullable required

URL of the next page, or null on the last page.

Changes

    • info

      added the new optional query request parameter broadcast_id

    • info

      added the new optional query request parameter replied

    • info

      added the optional property // to the response with the status

    • warning

      added the new payment-timing enum value to the /// response property for the response status

    • info

      added the optional property // to the response with the status