light-mode-image
Learn
MATTR VII PlatformInboxes

List inboxes

Returns a list of all inboxes on the tenant.

Analytic events

  • MESSAGING_INBOX_RETRIEVE_LIST_START
  • MESSAGING_INBOX_RETRIEVE_LIST_SUCCESS
  • MESSAGING_INBOX_RETRIEVE_LIST_FAIL
GET/v1/messaging/inboxes

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Default100
Range1 <= value <= 1000
cursor?string

Starting point for the list of entries.

Response Body

application/json

curl -X GET "https://example.vii.au01.mattr.global/v1/messaging/inboxes"
{
  "data": [
    {
      "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",
      "name": "My_Inbox"
    },
    {
      "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",
      "name": "My_Inbox"
    }
  ],
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}

How would you rate this page?