List all connections

GET 
/digital-wallet/connections

This endpoint lists all connections.

Request

Query Parameters

offset integerrequired

Requested index for start of resources to be provided in response requested by client

limit integerrequired

Default value: 10

Number of items returned per page. Requested number of resources to be provided in response requested by client

alias string

Alias

initiator string

Possible values: [self, external, multiuse]

Connection initiator

invitationKey string

Invitation key

myDid string

My DID

state string

Possible values: [init, invitation, request, response, active, error, inactive]

Connection state

theirDid string

Their DID

theirRole string

Their assigned connection role

Responses

200

A list of connections.

Response Headers

application/json

Schema

Schema

connections object[]
Array [
id string
Identifier
accept string
Possible values: [manual, auto]
Connection acceptance
alias string
Optional alias to apply to connection for later use
connectionId string
Connection identifier
createdAt string
Time of record creation
errorMsg string
Error message
inboundConnectionId string
Inbound routing connection id to use
initiator string
Possible values: [self, external, multiuse]
Connection initiator
invitationKey string
Public key for connection
invitationMode string
Possible values: [once, multi, static]
Invitation mode
myDid string
Our DID for connection
requestId string
Connection request identifier
routingState string
Routing state of connection
state string
Current record state
theirDid string
Their DID for connection
theirLabel string
Their label for connection
theirRole string
Their assigned role for connection
trustAnchor string
Trust anchor for connection
updatedAt string
Time of last record update
]
pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

Example (from schema)

{
  "connections": [
    {
      "id": "65e760f8dcf16cb987552297",
      "accept": "auto",
      "alias": "Bob, providing quotes",
      "connectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2024-02-28 07:03:35Z",
      "errorMsg": "No DIDDoc provided; cannot connect to public DID",
      "inboundConnectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "initiator": "self",
      "invitationKey": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV",
      "invitationMode": "once",
      "myDid": "WgWxqztrNooG92RXvxSTWv",
      "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "routingState": "active",
      "state": "active",
      "theirDid": "WgWxqztrNooG92RXvxSTWv",
      "theirLabel": "Bob",
      "theirRole": "Point of contact",
      "trustAnchor": "sovrinlive",
      "updatedAt": "2024-02-28 07:03:35Z"
    }
  ],
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

400

bad input parameter

Response Headers

Loading...