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

# List Counterparties

`GET /api/v1/counterparties/`

## Request

- Base URL: `https://merchant-api.accruesavings.com`
- URL: `https://merchant-api.accruesavings.com/api/v1/counterparties/`
- Auth: none declared. Required headers: `Client-ID`, `Authorization`
- TypeScript: <https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/counterparties/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns every counterparty unless `page[offset]` or `page[limit]` is sent. When either is sent, the response is one page ordered by creation time and `meta.total` counts all your counterparties; page with `page[offset]` until you have read `meta.total` records.

## Query parameters

- `page[limit]` integer: Maximum counterparties per page, at most 50 (larger values are clamped). Defaults to 10 once either page parameter is sent.
- `page[offset]` integer: Number of counterparties to skip, in creation order. Defaults to 0 once either page parameter is sent.

## Headers

- `Client-ID` string, uuid, required: The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
- `Authorization` string, uuid, required: Secure secret to access privileged endpoints.

## Response `200`

OK

- ListCounterpartiesResponse
  - `data` Counterparty[], required
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'Counterparty', required
    - `attributes` object, required
      - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required
      - `label` string: Optional label for the counterparty.
      - `accountNumber` string: Deprecated. Use `externalBankAccount.accountNumber` instead. Still returned for compatibility.
      - `routingNumber` string: Deprecated. Use `externalBankAccount.routingNumber` instead. Still returned for compatibility.
      - `accountType` 'Checking' | 'Savings': Deprecated. Use `externalBankAccount.accountType` instead. Still returned for compatibility.
      - `externalBankAccount` CounterpartyExternalBankAccount: The payee's own bank account for settlement.
        - `accountNumber` string, required: The payee's bank account number for settlement.
        - `routingNumber` string, required: The payee's ABA routing number for settlement.
        - `accountType` 'Checking' | 'Savings', required: The type of the payee's settlement bank account.
      - `internalBankAccount` CounterpartyInternalBankAccount: The Accrue bank account associated with this counterparty. Present only when a dedicated Accrue deposit account has been provisioned. Use these details to send funds to this counterparty over bank rails.
        - `accountNumber` string, required: Account number of the Accrue bank account associated with this counterparty.
        - `routingNumber` string, required: Routing number of the Accrue bank account associated with this counterparty.
        - `accountType` 'Checking' | 'Savings', required: Account type of the Accrue bank account associated with this counterparty.
      - `balance` object
        - `pending` integer, required: Incoming credits that have not posted yet, in cents. Outgoing payouts and transfers are not included. Can exceed the int32 range — read it into a 64-bit integer.
        - `available` integer, required: Posted credits minus every debit, whether posted or still in flight, in cents. This is the amount that can be paid out now. Can exceed the int32 range — read it into a 64-bit integer. A single payout is capped below this (see the payout `amount` field), so a balance above that cap is paid out across multiple payouts.
        - `posted` integer, required: Posted credits minus posted debits, in cents. It changes only when a transaction posts (a transaction's `postedAt`), so it is the balance to reconcile the `Posted` transactions against. `posted - available` is the debits still in flight, such as payouts that have not completed. Can exceed the int32 range — read it into a 64-bit integer.
  - `meta` object
    - `total` number, required
    - `limit` number, required
    - `offset` number, required

## Other responses

- `401`: Unauthorized
- `500`: Internal Server Error

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)