List counterparties

GET

/counterparties

Returns a paginated list of counterparties belonging to the authenticated entity, sorted by creation date (newest first).

Pagination is cursor-based: to retrieve the next page, pass the cursor value returned in meta.pagination.cursor from the previous response. When meta.pagination.has_more is false, you have reached the end of the list.

You can narrow the results using the optional filter parameters: email, client_reference, and status. All active filters are combined with AND logic.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

A page of counterparties returned successfully. If there are no counterparties matching the query, data will be an empty array.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/counterparties?cursor=01HZ9KPQR3VTXMN84JWYB65CD0&limit=25&email=jane.doe%40example.com&client_reference=cust-00412&status=active' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Page with results and a next cursor

{
    "message": "Counterparties retrieved successfully",
    "status": "success",
    "data": [
        {
            "id": "01HZ9KPQR3VTXMN84JWYB65CD0",
            "entity_id": "01HZ9ABCD1234EFGH5678IJKL90",
            "email": "jane.doe@example.com",
            "status": "active",
            "first_name": "Jane",
            "last_name": "Doe",
            "phonenumber": "+2348031234567",
            "client_reference": "cust-00412",
            "created": 1722870000000,
            "updated": 1722873600000
        },
        {
            "id": "01HZ9ABCDEFGH1234567890LMNO",
            "entity_id": "01HZ9ABCD1234EFGH5678IJKL90",
            "email": "john.smith@example.com",
            "status": "active",
            "first_name": "John",
            "last_name": "Smith",
            "created": 1722860000000,
            "updated": 1722860000000
        }
    ],
    "meta": {
        "pagination": {
            "cursor": "01HZ9ABCDEFGH1234567890LMNO",
            "has_more": true
        }
    }
}

Modified at 2026-08-12 16:05:45

Create a counterparty

Update a counterparty