Skip to content

Identity: inbox

View as Markdown

Thread count, unread total and newest activity over every thread, counted by the object

Section titled “Thread count, unread total and newest activity over every thread, counted by the object”

GET /v1/identities/{slug}/inbox · operation getInboxTotals

Requires the batondeck:messages:read permission (action message:read).

Parameters

Name In Type Required Notes
slug path string yes

Responses

Status Meaning
200 Thread count, unread total and newest activity over every thread, counted by the object
401 No portal session, and no live API key.
403 The policy refused, or the request was cross-site.
404 No such resource, or none this session may see.
200 response schema
{
"type": "object",
"properties": {
"threads": {
"type": "number"
},
"unread": {
"type": "number"
},
"last_at": {
"type": "number"
}
},
"required": [
"threads",
"unread",
"last_at"
],
"additionalProperties": false
}
Terminal window
curl -X GET 'https://api.batondeck.com/v1/identities/:slug/inbox' \
-H "Authorization: Bearer $BATONDECK_API_KEY"