MATTR Learn

Retrieves a list of all the DIDs registered with the requested inbox.

Analytics Events

MESSAGING_INBOX_DID_RETRIEVE_LIST_STARTMESSAGING_INBOX_DID_RETRIEVE_LIST_SUCCESSMESSAGING_INBOX_DID_RETRIEVE_LIST_FAIL

Roles

adminissuer

GET/v1/messaging/inboxes/{id}/dids

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Requested inbox ID

Query Parameters

limit?number

Range size of returned list.

Default100

Range1 <= value <= 1000

cursor?string

Starting point for the list of entries.

Response Body

curl -X GET "https://example.vii.au01.mattr.global/v1/messaging/inboxes/string/dids?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"

curl -X GET "https://example.vii.au01.mattr.global/v1/messaging/inboxes/string/dids?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"

{
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  "data": [
    "did:key:did1",
    "did:key:did2",
    "did:key:did3"
  ]
}

{
  "code": "BadRequest",
  "message": "Validation Error",
  "details": [
    {
      "value": "notUUIDvalue",
      "msg": "Invalid value",
      "param": "inboxId",
      "location": "params"
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve inbox DIDs