Retrieve inbox DIDs

GET

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

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

Roles

adminissuermanaged-issuer

Analytics Events

MESSAGING_INBOX_DID_RETRIEVE_LIST_STARTMESSAGING_INBOX_DID_RETRIEVE_LIST_SUCCESSMESSAGING_INBOX_DID_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

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

A list of inbox DIDs

application/json

response

nextCursor?string

data?array<string>

Array of DIDs which are registered with this inbox.

Example Request

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

Example ResponseSchema

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

GET

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

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

Roles

adminissuermanaged-issuer

Analytics Events

MESSAGING_INBOX_DID_RETRIEVE_LIST_STARTMESSAGING_INBOX_DID_RETRIEVE_LIST_SUCCESSMESSAGING_INBOX_DID_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

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

A list of inbox DIDs

application/json

response

nextCursor?string

data?array<string>

Array of DIDs which are registered with this inbox.

Example Request

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

Example Request

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

Example ResponseSchema

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

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

Roles

Analytics Events

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Retrieve inbox DIDs

Roles

Analytics Events

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Query Parameters

Response Body

Authorization

Path Parameters

Query Parameters

Response Body