Counterparties

List Counterparties

Returns a list of counterparties belonging to customers under the org. Account and routing numbers are masked — only the last 4 digits are exposed.

Verb	GET
URL	https://api.s.unit.sh/ready-to-launch/counterparties
Required Scope	counterparties
Timeout (Seconds)	5

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Optional. Maximum number of resources to return.
page[offset]	integer	0	Optional. Number of resources to skip. See Pagination.
filter[customerId]	integer	(empty)	Optional. Return only counterparties of this customer.
filter[userId]	string	(empty)	Optional. Return only counterparties of the customer this end-user belongs to.
sort	string	-createdAt	Optional. createdAt (ascending) or -createdAt (descending).

When no filter is provided, all counterparties in the org are returned. When filter[customerId] or filter[userId] is provided, results are scoped to that customer.

Example Request:

curl -X GET 'https://api.s.unit.sh/ready-to-launch/counterparties' \
-H "Authorization: Bearer ${TOKEN}"

Response

Returns a list of counterparties with their details.

Response is a JSON:API document.

200 OK

Name	Type	Description
data	Array of counterparties	Array of counterparty resources.

Attributes

Name	Type	Description
name	string	The name of the counterparty.
routingNumberLast4	string	The last 4 digits of the counterparty's routing number.
accountNumberLast4	string	The last 4 digits of the counterparty's account number.
createdAt	string	The date the counterparty was created.
updatedAt Optional	string	The date the counterparty was last updated.
tags Optional	object	Tags associated with the counterparty.

Relationships

Name	Type	Description
customer	object	The customer owning the counterparty.

Example Response:

{
  "data": [
    {
      "type": "counterparty",
      "id": "5001",
      "attributes": {
        "name": "ACME Corp",
        "routingNumberLast4": "0021",
        "accountNumberLast4": "6789",
        "createdAt": "2026-09-01T12:34:56.000Z",
        "updatedAt": "2026-09-10T08:00:00.000Z",
        "tags": {}
      },
      "relationships": {
        "customer": { "data": { "type": "customer", "id": "10001" } }
      }
    }
  ]
}