List inboxes

GET

/v1/messaging/inboxes

Returns a list of all inboxes on the tenant.

Roles

adminissuermanaged-issuer

Analytics Events

MESSAGING_INBOX_RETRIEVE_LIST_STARTMESSAGING_INBOX_RETRIEVE_LIST_SUCCESSMESSAGING_INBOX_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

A list of inboxes

application/json

response

data?array<>

Items2 <= items

nextCursor?string

Starting point for next cursor to use in a page

Example Request

curl -X GET 'https://example.vii.au01.mattr.global/v1/messaging/inboxes'

Example ResponseSchema

{  "data": [    {      "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",      "name": "My_Inbox"    },    {      "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",      "name": "My_Inbox"    }  ],  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}

GET

/v1/messaging/inboxes

Returns a list of all inboxes on the tenant.

Roles

adminissuermanaged-issuer

Analytics Events

MESSAGING_INBOX_RETRIEVE_LIST_STARTMESSAGING_INBOX_RETRIEVE_LIST_SUCCESSMESSAGING_INBOX_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

A list of inboxes

application/json

response

data?array<>

Items2 <= items

nextCursor?string

Starting point for next cursor to use in a page

Example Request

curl -X GET 'https://example.vii.au01.mattr.global/v1/messaging/inboxes'

Example Request

curl -X GET 'https://example.vii.au01.mattr.global/v1/messaging/inboxes'

Example ResponseSchema

{
  "data": [
    {
      "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",
      "name": "My_Inbox"
    },
    {
      "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",
      "name": "My_Inbox"
    }
  ],
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}

{  "data": [    {      "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",      "name": "My_Inbox"    },    {      "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",      "name": "My_Inbox"    }  ],  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}

Roles

Analytics Events

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

List inboxes

Roles

Analytics Events

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Response Body

Authorization

Query Parameters

Response Body