List counterparties

get/api/address-book/v1/connections/counterparties

Lists connections others have made from their Go Account to your Go Account.

Query Parameters

  • limitstring or numberRequired
  • offsetstring or numberRequired
  • idarray[string]
  • statusarray[string]
    Enum: PENDING_DEACTIVATION PENDING_ACTIVATION ACTIVE INACTIVE
  • orderBystringRequired
    Enum: description connectionType createdAt updatedAt
  • orderDirectionstringRequired
    Enum: ASC DESC
  • namestring
    Min length: >= 1 characters
  • ownerWalletIdarray[string]
    Min length: >= 1 characters

200 Response

connections array[object] required
ownerListingEntry object required
targetListingEntry object required
id string required
type string required
codec for valid connection statuses
Allowed values: DVP WHITELIST
status string required
codec for valid connection statuses
Allowed values: PENDING_DEACTIVATION PENDING_ACTIVATION ACTIVE INACTIVE
label string required
Min length: >= 1 characters
description string
Min length: >= 1 characters
createdBy string required
Min length: >= 1 characters
updatedBy string required
Min length: >= 1 characters
createdAt string <date-time>required
updatedAt string <date-time>required

400 Response

401 Response

errorName string required
error string required

403 Response

errorName string required
error string required

500 Response

errorName string required
error string required