List a mailbox's conversations
The threads in one mailbox, newest activity first, from the Inbox view or the Spam view.
This is correspondence from people outside your project, who wrote to your address without ever dealing with Sendly. That is why it has a scope of its own and is not covered by mailboxes:read, which is the mailbox's settings and never its contents.
No existing API key can call this. The scope is opt-in only: a key or an OAuth connection holds it only if it was ticked by name when the credential was created or approved — the legacy full-access key and the "Full access" preset do not carry it.
Pages through nextCursor: pass it back as cursor until it is null. The mailbox must belong to the project the credential resolves to; one in another project answers 404.
Requires the mailbox-conversations:read scope — Read the conversations in your hosted mailboxes — every message and attachment people have sent you.
API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.
In: header
Path Parameters
Query Parameters
Default inbox.
Default all.
Case-insensitive substring match on the subject or the correspondent's address.
The nextCursor of the previous page.
Page size. Default 30, at most 50.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/mailboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08/conversations"{
"success": true,
"data": {
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"subject": "string",
"lastMessageAt": "2019-08-24T14:15:22Z",
"messageCount": 0,
"status": "OPEN",
"spam": true,
"assignee": {
"id": "string",
"name": "string"
},
"hasUnread": true,
"contact": {
"email": "user@example.com",
"name": "string"
},
"latestMessage": {
"direction": "INBOUND",
"from": "string",
"recipient": "string"
},
"mailbox": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"address": "user@example.com"
}
}
],
"nextCursor": "string"
}
}{
"success": false,
"error": {
"message": "string",
"code": "string",
"details": {
"errors": [
null
]
}
}
}{
"success": false,
"error": {
"message": "string",
"code": "string",
"details": {
"errors": [
null
]
}
}
}{
"success": false,
"error": {
"message": "string",
"code": "string",
"details": {
"errors": [
null
]
}
}
}{
"success": false,
"error": {
"message": "string",
"code": "string",
"details": {
"errors": [
null
]
}
}
}{
"success": false,
"error": {
"message": "string",
"code": "string",
"details": {
"errors": [
null
]
}
}
}{
"success": false,
"error": {
"message": "string",
"code": "string",
"details": {
"errors": [
null
]
}
}
}