# List counterparty addresses

List all addresses within a counterparty

Endpoint: GET /v2/counterparties/{counterpartyId}/addresses
Version: 2.0
Security: TokenAuth

## Path parameters:

  - `counterpartyId` (string, required)
    The counterparty ID

## Query parameters:

  - `pageSize` (integer)
    The number of results to return per page (default 50, max 100)

  - `pageToken` (string)
    The token to retrieve the next page of results

## Response 200 fields (application/json):

  - `filter` (object)

  - `filter.previousPageToken` (string)
    The token to retrieve the previous page of results
    Example: "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA="

  - `filter.nextPageToken` (string)
    The token to retrieve the next page of results
    Example: "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA="

  - `filter.total` (integer, required)
    The total number of results
    Example: 100

  - `addresses` (array)

  - `addresses.addressId` (string, required)
    The address ID
    Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

  - `addresses.counterpartyId` (string, required)
    The counterparty ID
    Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

  - `addresses.createdBy` (string, required)
    The ID of the user who created this address
    Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

  - `addresses.createdAt` (string, required)
    The date and time the address was created
    Example: "2022-03-29T10:22:22.420Z"

  - `addresses.updatedBy` (string, required)
    The ID of the user who updated this address
    Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

  - `addresses.updatedAt` (string, required)
    The date and time the address was updated
    Example: "2022-03-29T10:22:22.420Z"

  - `addresses.custodian` (object)

  - `addresses.custodian.name` (string, required)
    The Virtual Asset Service Provider's name
    Example: "Palisade Financial"

  - `addresses.custodian.dId` (string, required)
    The Virtual Asset Service Provider's Decentralized Identifier
    Example: "did:example:123456789abcdefghi"

  - `addresses.termsAndConditionsAccepted` (boolean, required)
    Whether the user has accepted the terms and conditions
    Example: true

  - `addresses.details` (object, required)

  - `addresses.details.type` (string, required)
    Enum: "EXTERNAL"

  - `addresses.details.externalAddress` (object)

  - `addresses.details.externalAddress.address` (string, required)
    The address
    Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"

  - `addresses.details.externalAddress.name` (string, required)
    The address name
    Example: "Treasury"

  - `addresses.details.externalAddress.description` (string)
    The address description
    Example: "Wallet used to store treasury funds"

  - `addresses.details.externalAddress.blockchains` (array, required)
    The blockchains supported by the address
    Enum: "AVALANCHE", "ETHEREUM", "XRP_LEDGER", "POLYGON", "BNBCHAIN", "BASE", "HEDERA", "ARBITRUM", "ONE_MONEY", "SOLANA", "TRON", "BITCOIN"

  - `addresses.status` (string, required)
    Enum: "CREATED", "ENABLED", "REJECTED", "DELETED", "ERROR", "COMPLIANCE_PENDING", "COMPLIANCE_COMPLETE", "CREATION_APPROVAL_PENDING", "CREATION_APPROVAL_COMPLETE", "DELETION_APPROVAL_PENDING", "DELETION_APPROVAL_COMPLETE"

  - `addresses.active` (boolean, required)
    Whether the address is active
    Example: true

## Response 400 fields (application/json):

  - `code` (integer)

  - `message` (string)

  - `details` (array)

  - `details.@type` (string)