Sign in

v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

Retrieve a thread's read status

Returns the read status of a thread for the specified user, including the ID of the last message they have read and the number of unread messages remaining.

For user-authenticated requests, the status is always returned for the authenticated user and the user parameter is ignored. For server-to-server (S2S) requests, the user parameter is required and must be a valid user ID.

Returns 404 if the thread does not exist or the caller does not have access to it.

get/api/v1/threads/{thread}/read_status

Path parameters

threadstring required

Thread ID (thr_...). Must be accessible to the authenticated user or, for S2S requests, to the specified user.

Query parameters

userstring

User ID (usr_...) whose read status to retrieve. Required for S2S requests; ignored for user-authenticated requests, which always return the status for the authenticated user.

Response

Successful response

last_read_messagestring

Message ID (msg_...) of the last message the user has read in this thread. null if the user has never read any message in the thread.

threadstring required

Thread ID (thr_...) that this read status belongs to.

unread_countinteger required

Number of messages in the thread that the user has not yet read.

Example response

{
  "last_read_message": "string",
  "thread": "string",
  "unread_count": 1
}