---
title: "List counterparties"
method: GET
path: "/counterparties"
tags: ["Counterparties"]
deprecated: true
---

# List counterparties

`GET /counterparties`

> **Deprecated.**

List and filter counterparties.

## Query parameters

- `limit` integer
- `starting_after` string, uuid
- `sort_order` 'asc' | 'desc'
- `start_date` string, date
- `end_date` string, date
- `name` string
- `disabled` boolean
- `counterparty_account_id` string, uuid
- `virtual_account_id` string, uuid

## Response `200`

200

- CounterpartiesSearchResult
  - `records` CounterpartiesCounterparty[]
    - `id` string, uuid, required — The UUID of the counterparty.
    - `name` string, required — The name of the counterparty
    - `object` string, required — Type of the object, `counterparty`.
    - `created_at` string, date-time, required — The UTC timestamp of the creation of this counterparty.
    - `disabled_at` string, date-time — The UTC timestamp of the disabling of this counterparty.
    - `counterparty_accounts` CounterpartyAccountsCounterpartyAccountEmbedded[]
      - `id` string, uuid, required — The UUID of the counterparty account.
      - `name` string — The name of the counterparty account.
      - `status` 'pending_approval' | 'approved' | 'denied' | 'disabled', required — The status of this counterparty account.
      - `status_details` string, required — The details of the status of this counterparty account.
      - `holder_name` string, required — The name of the legal entity or individual holding the account.
      - `account_number` string, required — The account number.
      - `bank_code` string, required — The bank code, for instance BIC / Swift code, UK sort code, or US routing number.
      - `holder_address` CounterpartyAccountsHolderAddress, required — The address of the account holder, as an address object.
        - `line_1` string — Line 1.
        - `line_2` string — Line 2.
        - `building_number` string — Building number.
        - `street_name` string — Street name.
        - `postal_code` string — Postal / zip code.
        - `region_state` string — Region or state.
        - `city` string — City.
        - `country` string — ISO 3166 alpha-2 country code.
      - `created_at` string, date-time, required — The UTC timestamp of the creation of this counterparty account.
      - `disabled_at` string, date-time — The UTC timestamp of the disabling of this counterparty account.
    - `virtual_accounts` CounterpartyAccountsVirtualAccountEmbedded[]
      - `id` string, uuid, required — The UUID of the virtual account.
      - `connected_account_id` string, uuid, required — The ID of the connected account to which the virtual account refers.
      - `name` string — The name of the virtual account.
      - `virtual_account_number` string, required — The virtual account number.
      - `created_at` string, date-time, required — The UTC timestamp of the creation of this virtual account.
      - `disabled_at` string, date-time — The UTC timestamp of the disabling of this virtual account.
    - `metadata` object — Additional client data in JSON format. See [Metadata](https://docs.numeral.io/reference/metadata).

## Other responses

- `400` — Validation error.

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/revisions/220f101cc2ef/schema)