Retrieve unread messages

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.

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>.

Response

Messages

resultslist of objects

Errors

4XX

Client Request Error

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>.

1	{
2	"results": [
3	{
4	"id": "5f8d0c3e4b2a1c0012345678",
5	"sender_id": "user_987654321",
6	"body": "I noticed an issue with the payment timing for my last study.",
7	"sent_at": "2024-01-15T09:30:00Z",
8	"channel_id": "d45c8a5e812ff990fc6546beaf888c9820f4c184f7200a45d900cf0f321f7f38",
9	"type": "message",
10	"data": {
11	"study_id": "620ca2735fcbba4fa2b3211a",
12	"category": "payment-timing"
13	}
14	}
15	]
16	}

1	{
2	"results": [
3	{
4	"id": "5f8d0c3e4b2a1c0012345678",
5	"sender_id": "user_987654321",
6	"body": "I noticed an issue with the payment timing for my last study.",
7	"sent_at": "2024-01-15T09:30:00Z",
8	"channel_id": "d45c8a5e812ff990fc6546beaf888c9820f4c184f7200a45d900cf0f321f7f38",
9	"type": "message",
10	"data": {
11	"study_id": "620ca2735fcbba4fa2b3211a",
12	"category": "payment-timing"
13	}
14	}
15	]
16	}

$	curl https://api.prolific.com/api/v1/messages/unread/ \
>	-H "Authorization: Token <token>" \
>	-H "Content-Type: application/json"