Inbox API
Summary and assignees
Both endpoints require the read:emails scope.
GET /api/v1/inbox/summary
The counts the inbox rail shows, and how long customers have been waiting.
GET /api/v1/inbox/summary?asUserId=cmq1user0alk34567891 HTTP/1.1
Host: agentlyleads.com
Authorization: Bearer alk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx{
"summary": {
"unassigned": 4,
"mine": 2,
"open": 11,
"closed": 37,
"spam": 3,
"trash": 1,
"waiting": 6,
"overdue": 1,
"oldestWaitingMins": 1570,
"slaMins": 240
}
}| Field | Description |
|---|---|
unassigned | Open conversations with no owner |
mine | Open conversations owned by asUserId. Null when asUserId is not given |
open / closed | Conversations by state, not counting spam, trash or bulk |
spam / trash | Conversations in those folders |
waiting | Open conversations whose last message is from the customer |
overdue | Of those, past the workspace's first-response target |
oldestWaitingMins | The longest current wait |
slaMins | The first-response target in minutes, or null when none is set |
Counts cover the same window as the list: the conversations behind the most recent 1,000 messages.
GET /api/v1/inbox/assignees
Everyone a conversation can be assigned to: the active users in this workspace.
{
"assignees": [
{ "id": "cmq1user0alk34567890", "name": "Olive Park", "away": false },
{ "id": "cmq1user0alk34567891", "name": "Rita Cole", "away": true }
]
}away is shown, not filtered. Round-robin assignment skips people who are away; you can still assign to them by ID.