light-mode-image
Learn
API ReferenceInboxes

Retrieve all messages

Roles

adminissuermanaged-issuer

Analytics Events

MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_STARTMESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_SUCCESSMESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_FAIL
GET/v1/messaging/inboxes/{id}/messages

Retrieving all the messages from an inbox

Analytic events

  • MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_START
  • MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_SUCCESS
  • MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Requested inbox ID

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000
Default100
cursor?string

Starting point for the list of entries.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/messaging/inboxes/string/messages"
{  "nextCursor": "string",  "data": [    {      "name": "string",      "createdAt": "2019-08-24",      "id": "string",      "inboxId": "string",      "payload": "string"    },    {      "name": "string",      "createdAt": "2019-08-24",      "id": "string",      "inboxId": "string",      "payload": "string"    }  ]}

How would you rate this page?

Unregister DID with an inbox DELETE

Unregisters a DID from the requested inbox. ### **Analytic events** * MESSAGING_INBOX_DID_UNREGISTER_START * MESSAGING_INBOX_DID_UNREGISTER_SUCCESS * MESSAGING_INBOX_DID_UNREGISTER_FAIL

Retrieve a message GET

Retrieves a message from the requested inbox by providing its ID. ### **Analytic events** * MESSAGING_INBOX_MESSAGE_RETRIEVE_START * MESSAGING_INBOX_MESSAGE_RETRIEVE_SUCCESS * MESSAGING_INBOX_MESSAGE_RETRIEVE_FAIL