PRprolific
messages

Retrieve messages

Changed on

Get messages between you and another user or your messages with all users.

get/api/v1/messages/

Request

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

Query parameters

user_idstring

Another user ID, must be provided if no created_after date is provided.

created_afterstring

Only fetch messages created after timestamp. Datetime in ISO8601 format. Must be provided if no user_id is provided. You can only fetch up to the last 30 days of messages.

excluded_sender_idsstring

A comma-separated list of sender IDs whose messages should be excluded from the response. Maximum 10 IDs.

e.g. excluded_sender_ids=abc,def.

workspace_idstring

Optional. The ID of one of your workspaces. When provided, the response contains the messages belonging to that workspace rather than the messages belonging to your own account, so you see the conversations of every member of the workspace in one place.

This parameter is intended for workspaces that have workspace messaging enabled. If workspace messaging is not enabled for the given workspace, no messages are returned.

You must be a member of the workspace you request. This parameter cannot be used by participants.

Read more about workspace messaging: https://researcher-help.prolific.com/en/articles/445238-workspace-messaging

study_idstring

Optional. Only return messages sent with this exact study_id. Use study_id=null to return only messages that are not associated with any study. Omit the parameter to return messages regardless of study. Only supported alongside created_after. Cannot be combined with user_id or excluded_sender_ids.

Response

Messages

Changes