Skip to main content
GET
/
v1
/
partner
/
clients
List partner clients
curl --request GET \
  --url https://api-sandbox.circle.com/v1/partner/clients \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "clientEntityId": "880e8400-e29b-41d4-a716-446655440099",
      "clientName": "Acme Trust Co.",
      "country": "US",
      "clientType": "business",
      "businessDetails": {
        "natureOfBusiness": "paymentProcessorPlatform",
        "institutionType": "privateCo"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
pageSize
integer
default:50

Number of clients to return per page, between 1 and 100. Defaults to 50. Values outside this range return a 400 Bad Request error.

Required range: 1 <= x <= 100
Example:

50

​
pageAfter
string<uuid>

Cursor for the next page: the pageAfter value from the previous response's Link: rel="next" header. Omit to fetch the first page. A cursor that does not reference a known client returns a 400 Bad Request error.

Example:

"880e8400-e29b-41d4-a716-446655440099"

Response

One page of the partner's clients

​
data
object[]

One page of clients, newest first.