For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Go to app
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
    • Introduction
    • Users
    • Taskflow
    • AI Task Builder
    • Studies
    • Representative sample studies
    • study-collections
    • Filter Sets
    • Participant Groups
    • Custom Groups
    • Study Distribution
    • Submissions
    • Bonuses
    • Messages
      • GETRetrieve messages
      • POSTSend a message
      • POSTSend a message to multiple participants
      • POSTSend a message to a participant group
      • GETRetrieve unread messages
    • Workspaces
    • Projects
    • Surveys
    • Webhooks
    • Invitations
    • Reward Recommendations
    • Testing
    • Well Known Endpoints
Go to app
LogoLogo
API ReferenceMessages

Retrieve messages

|View as Markdown|Open in Claude|
GET
https://api.prolific.com/api/v1/messages/
GET
/api/v1/messages/
$curl https://api.prolific.com/api/v1/messages/ \
>     -H "Authorization: Token <token>" \
>     -H "Content-Type: application/json"
1{
2  "results": [
3    {
4      "id": "5f8d0c3e4b2a1c0012345678",
5      "sender_id": "user_987654321",
6      "body": "Hi, I have a question about the recent study payment.",
7      "sent_at": "2024-01-15T09:30:00Z",
8      "channel_id": "d45c8a5e812ff990fc6546beaf888c9820f4c184f7200a45d900cf0f321f7f38",
9      "type": "message",
10      "data": {
11        "study_id": "620ca2735fcbba4fa2b3211a",
12        "category": "payment-issues"
13      }
14    }
15  ]
16}
Get messages between you and another user or your messages with all users.
Was this page helpful?
Previous

Messages

Next

Send a message

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_idstringOptional

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

created_afterstringOptional

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.

Response

Messages
resultslist of objects

Errors

4XX
Client Request Error