Retrieve messages
Get messages between you and another user or your messages with all users.
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
user_id
Another user ID, must be provided if no created_after date is provided.
created_after
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_ids
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_id
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_id
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
results
Errors
4XX
Client Request Error
503
Service Unavailable Error
504
Gateway Timeout Error