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

# List Counterparties

`GET /counterparties`

List Counterparties. `customerId` is an optional filter - omit it to list
all counterparties in the project (still tenant-scoped by project).

## Query parameters

- `limit` integer
- `startingAfter` string
- `endingBefore` string
- `customerId` string

## Response `200`

The request has succeeded.

- CounterpartyList
  - `object` string — Resource type discriminator.
  - `hasMore` boolean — True when more rows exist beyond this page in the direction of travel (forward by default, backward when `endingBefore` was supplied).
  - `nextCursor` string — Opaque cursor pointing at the last item in this page. Present when `data` is non-empty. Pass as `startingAfter` to fetch the next page; `hasMore=false` signals no more pages forward.
  - `previousCursor` string — Opaque cursor pointing at the first item in this page. Present when `data` is non-empty. Pass as `endingBefore` to page backward; when this yields an empty response the client is at the start of the list.
  - `data` Counterparty[] — The page of results.
    - `id` string — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired.
    - `object` 'counterparty'
    - `customerId` string — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired.
    - `status` 'active' | 'rejected' | 'deleted' — Lifecycle of a counterparty. `rejected` is reserved for create-time compliance screening (not yet active); `deleted` marks a soft-deleted record that remains readable by id.
    - `rejectionReason` string — Set when status = `rejected`.
    - `name` string — Full legal name or registered business name.
    - `entityType` 'individual' | 'business'
    - `address` Address, required — A postal address. country is an ISO 3166-1 alpha-2 country code.
      - `line1` string — Street address, line 1.
      - `line2` string — Street address, line 2.
      - `city` string — City.
      - `state` string — State / province / region.
      - `country` string — ISO 3166-1 alpha-2
      - `zipCode` string — ZIP / postal code.
    - `email` string
    - `phone` string
    - `taxId` string
    - `dateOfBirth` string, date
    - `nationality` string — ISO 3166-1 alpha-2.
    - `metadata` object
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

---

[API](https://skmtc.net/polygon-technology/apis/polygon-oms-public-api.md) · [All operations](https://skmtc.net/polygon-technology/apis/polygon-oms-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polygon-technology/polygon-oms-public-api/revisions/18fdaebf64e5/schema)