# List counterparty addresses

List all addresses within a counterparty

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

## Path parameters:

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

## Request fields (application/json):

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

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

  - `pagination` (object)
    Pagination and sorting. Sortable fields: address, name, status, active, created_at, updated_at.

  - `pagination.pageSize` (integer)
    Number of results per page (default 50, max 1000)
    Example: 50

  - `pagination.pageToken` (string)
    Token for pagination from previous response
    Example: "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA="

  - `pagination.orderBy` (string)
    Field to order results by
    Example: "created_at"

  - `pagination.order` (string)
    Sort order (ASC or DESC)
    Enum: "SORT_ORDER_ASC", "SORT_ORDER_DESC"

  - `filter` (object)
    Optional address filters. Each populated sub-filter is AND-ed.

  - `filter.addressId` (object)
    Filter by address ID

  - `filter.addressId.eq` (string)
    Exact match

  - `filter.addressId.notEq` (string)
    Not equal to

  - `filter.addressId.contains` (string)
    Contains substring (case-insensitive)

  - `filter.addressId.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.addressId.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.addressId.in` (array)
    Value is in the list

  - `filter.addressId.notIn` (array)
    Value is not in the list

  - `filter.addressId.isNull` (boolean)
    Check if field is null

  - `filter.counterpartyId` (object)
    Filter by counterparty ID. For scoped address list requests, the top-level counterparty_id still scopes the request; if both are supplied, both predicates are AND-ed.

  - `filter.counterpartyId.eq` (string)
    Exact match

  - `filter.counterpartyId.notEq` (string)
    Not equal to

  - `filter.counterpartyId.contains` (string)
    Contains substring (case-insensitive)

  - `filter.counterpartyId.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.counterpartyId.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.counterpartyId.in` (array)
    Value is in the list

  - `filter.counterpartyId.notIn` (array)
    Value is not in the list

  - `filter.counterpartyId.isNull` (boolean)
    Check if field is null

  - `filter.address` (object)
    Filter by on-chain address

  - `filter.address.eq` (string)
    Exact match

  - `filter.address.notEq` (string)
    Not equal to

  - `filter.address.contains` (string)
    Contains substring (case-insensitive)

  - `filter.address.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.address.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.address.in` (array)
    Value is in the list

  - `filter.address.notIn` (array)
    Value is not in the list

  - `filter.address.isNull` (boolean)
    Check if field is null

  - `filter.name` (object)
    Filter by address name

  - `filter.name.eq` (string)
    Exact match

  - `filter.name.notEq` (string)
    Not equal to

  - `filter.name.contains` (string)
    Contains substring (case-insensitive)

  - `filter.name.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.name.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.name.in` (array)
    Value is in the list

  - `filter.name.notIn` (array)
    Value is not in the list

  - `filter.name.isNull` (boolean)
    Check if field is null

  - `filter.description` (object)
    Filter by address description

  - `filter.description.eq` (string)
    Exact match

  - `filter.description.notEq` (string)
    Not equal to

  - `filter.description.contains` (string)
    Contains substring (case-insensitive)

  - `filter.description.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.description.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.description.in` (array)
    Value is in the list

  - `filter.description.notIn` (array)
    Value is not in the list

  - `filter.description.isNull` (boolean)
    Check if field is null

  - `filter.status` (string)
    Filter by address status
    Enum: "CREATED", "ENABLED", "REJECTED", "DELETED", "ERROR", "COMPLIANCE_PENDING", "COMPLIANCE_COMPLETE", "CREATION_APPROVAL_PENDING", "CREATION_APPROVAL_COMPLETE", "DELETION_APPROVAL_PENDING", "DELETION_APPROVAL_COMPLETE"

  - `filter.active` (object)
    Filter by active status

  - `filter.active.eq` (boolean)
    Equals

  - `filter.active.isNull` (boolean)
    Check if field is null

  - `filter.blockchain` (object)
    Filter by supported blockchain

  - `filter.blockchain.eq` (string)
    Exact blockchain match
    Enum: "AVALANCHE", "ETHEREUM", "XRP_LEDGER", "POLYGON", "BNBCHAIN", "BASE", "HEDERA", "ARBITRUM", "ONE_MONEY", "SOLANA", "TRON", "BITCOIN"

  - `filter.blockchain.notEq` (string)
    Exclude this blockchain
    Enum: same as `filter.blockchain.eq` (12 values)

  - `filter.blockchain.in` (array)
    Blockchain is in this list
    Enum: same as `filter.blockchain.eq` (12 values)

  - `filter.blockchain.notIn` (array)
    Blockchain is not in this list
    Enum: same as `filter.blockchain.eq` (12 values)

  - `filter.createdAt` (object)
    Filter by creation timestamp

  - `filter.createdAt.eq` (string)
    Exact timestamp match
    Example: "2024-08-08T10:00:00Z"

  - `filter.createdAt.notEq` (string)
    Not equal to timestamp
    Example: "2024-08-08T10:00:00Z"

  - `filter.createdAt.before` (string)
    Before this timestamp
    Example: "2024-08-08T10:00:00Z"

  - `filter.createdAt.after` (string)
    After this timestamp
    Example: "2024-08-08T10:00:00Z"

  - `filter.createdAt.gte` (string)
    Greater than or equal to timestamp
    Example: "2024-08-08T10:00:00Z"

  - `filter.createdAt.lte` (string)
    Less than or equal to timestamp
    Example: "2024-08-08T10:00:00Z"

  - `filter.createdAt.between` (object)
    Between two timestamps (inclusive)

  - `filter.createdAt.between.start` (string)
    Start of time range (inclusive)
    Example: "2024-08-01T00:00:00Z"

  - `filter.createdAt.between.end` (string)
    End of time range (inclusive)
    Example: "2024-08-31T23:59:59Z"

  - `filter.createdAt.isNull` (boolean)
    Check if field is null

  - `filter.createdAt.relativeDays` (integer)
    Relative days from now (negative for past, positive for future)
    Example: -7

  - `filter.updatedAt` (object)
    Filter by last-update timestamp

  - `filter.updatedAt.eq` (string)
    Exact timestamp match
    Example: "2024-08-08T10:00:00Z"

  - `filter.updatedAt.notEq` (string)
    Not equal to timestamp
    Example: "2024-08-08T10:00:00Z"

  - `filter.updatedAt.before` (string)
    Before this timestamp
    Example: "2024-08-08T10:00:00Z"

  - `filter.updatedAt.after` (string)
    After this timestamp
    Example: "2024-08-08T10:00:00Z"

  - `filter.updatedAt.gte` (string)
    Greater than or equal to timestamp
    Example: "2024-08-08T10:00:00Z"

  - `filter.updatedAt.lte` (string)
    Less than or equal to timestamp
    Example: "2024-08-08T10:00:00Z"

  - `filter.updatedAt.between` (object)
    Between two timestamps (inclusive)

  - `filter.updatedAt.between.start` (string)
    Start of time range (inclusive)
    Example: "2024-08-01T00:00:00Z"

  - `filter.updatedAt.between.end` (string)
    End of time range (inclusive)
    Example: "2024-08-31T23:59:59Z"

  - `filter.updatedAt.isNull` (boolean)
    Check if field is null

  - `filter.updatedAt.relativeDays` (integer)
    Relative days from now (negative for past, positive for future)
    Example: -7

  - `search` (string)
    Case-insensitive search over address ID, on-chain address, name, and description.
    Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"

## 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)
    The address details

  - `addresses.details.type` (string, required)
    The address type
    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: same as `filter.blockchain.eq` (12 values)

  - `addresses.status` (string, required)
    The address status
    Enum: same as `filter.status` (11 values)

  - `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)