DorkOS
ApiRead cursorsKindId

Read the caller's own position in one thread

GET
/api/read-cursors/{kind}/{id}

Where this person left off in one thread — the read half of the PUT, and the way a screen that has just opened knows where to draw the unread rule before any event arrives. A thread the caller has never read answers { "cursor": null } with a 200, because never-read is the state every thread starts in rather than a missing resource; null is also distinct from a stored 0, which is a thread read up to its own beginning. As with the write, the cursor is always the caller's own — there is no way to name a user — and an agent caller is refused with 403 PEOPLE_ONLY, or with 401 when its token does not verify.

Path Parameters

kind*string

Value in

  • "room"
  • "session"
  • "inbox"
id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/read-cursors/room/string"
{  "cursor": {    "userId": "string",    "threadKind": "room",    "threadId": "string",    "lastReadSeq": 0,    "updatedAt": "string"  }}