PRprolific
messages

Retrieve unread messages

Changed on

Get all unread messages. The messages you have sent are never returned, only messages you have received and not read. It does not mark those messages as read.

get/api/v1/messages/unread/

Request

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

Query parameters

workspace_idstring

Optional. The ID of one of your workspaces. When provided, the response contains the unread messages belonging to that workspace rather than the unread messages belonging to your own account, so you see the unread messages 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 unread 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

Response

Messages

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id get-unread-messages removed and replaced with messages_GetUnreadMessages