List in-app messages addressed to the caller
LogsGET /inbox
Returns the in-app messages addressed to the signed-in person across every utility, newest first, one cursor page at a time. Only messages with both a title and a body are listed, and archived messages are hidden unless include_archived is true. The caller must be a consumer identity that is not bound to a tenant; a staff or tenant-bound token receives 403. No account permission is needed, since the inbox belongs to the person.
Parameters
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
unread_onlyWhen
true, return only messages that have not been marked read; accepts Go boolean strings (true,false, 1, 0, t, f) and returns 400 for anything else.include_archivedWhen
true, also return archived messages, which are hidden by default; accepts Go boolean strings and returns 400 for anything else.
Returns
200 The caller's inbox messages
Show attributes
dataInbox messages addressed to the caller, newest first.
Show child attributes
idtenant_idintent_idevent_typetemplate_keytitlebodyresource_typeresource_idcreated_atread_atarchived_at
has_moreTrue when another page follows; pass next_cursor as after to read it.
next_cursorOpaque cursor for the next page; present only when has_more is
true.
curl -X GET "$CONSUMER_API/inbox" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$CONSUMER_API/inbox", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$CONSUMER_API/inbox",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$CONSUMER_API/inbox", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "not_2WyblSmD5mK7ZwWz32AntEotfiw",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"intent_id": "int_22Gr1MqNzCoLNQG9VCg3dYIRdQg",
"event_type": "event type",
"template_key": "template key",
"title": "Fuga na Rua 3",
"body": "Leitura confirmada no local.",
"resource_type": "resource type",
"resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
"created_at": "2026-11-19T09:30:00Z",
"read_at": "2026-11-19T09:30:00Z",
"archived_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}