> ## Documentation Index > Fetch the complete documentation index at: https://developers.circle.com/llms.txt > Use this file to discover all available pages before exploring further. # List partner clients > Retrieves the clients created under your partner account, newest first. Results are cursor-paginated, forward-only, via the `Link` response header. Each item always carries the `clientEntityId` and `created` timestamp. The profile fields (`clientName`, `country`, `clientType`, `businessDetails`) echo the details submitted at creation, while `status` and `balances` are enriched by Circle and omitted when not available. ## OpenAPI ````yaml openapi/customer-orchestration.yaml get /v1/partner/clients openapi: 3.0.2 info: version: ${version} title: Customer Orchestration API description: > API for managing partner client entities. Use these endpoints to create a client record and initialize an onboarding application on behalf of your customer, and to read back the clients created under your partner account. ## Authentication All endpoints require a Bearer token obtained via the Circle key exchange. Include the token in the `Authorization: Bearer ` header. servers: - url: https://api-sandbox.circle.com - url: https://api.circle.com security: [] tags: - name: Partner Clients description: >- Create client entities, initialize onboarding applications, and read back the clients created under your partner account. paths: /v1/partner/clients: get: tags: - Partner Clients summary: List partner clients description: >- Retrieves the clients created under your partner account, newest first. Results are cursor-paginated, forward-only, via the `Link` response header. Each item always carries the `clientEntityId` and `created` timestamp. The profile fields (`clientName`, `country`, `clientType`, `businessDetails`) echo the details submitted at creation, while `status` and `balances` are enriched by Circle and omitted when not available. operationId: listPartnerClients parameters: - name: pageSize in: query required: false description: >- Number of clients to return per page, between 1 and 100. Defaults to 50. Values outside this range return a `400 Bad Request` error. schema: type: integer minimum: 1 maximum: 100 default: 50 example: 50 - name: pageAfter in: query required: false description: >- 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. schema: type: string format: uuid example: 880e8400-e29b-41d4-a716-446655440099 responses: '200': description: One page of the partner's clients headers: X-Request-Id: $ref: '#/components/headers/XRequestId' Link: $ref: '#/components/headers/PaginationLink' content: application/json: schema: $ref: '#/components/schemas/ListPartnerClientsResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthorized' '403': $ref: '#/components/responses/Forbidden' security: - bearerAuth: [] components: headers: XRequestId: description: >- Universally unique identifier (UUID v4) for the request. Helpful for identifying a request when communicating with Circle support. schema: type: string format: uuid example: 2adba88e-9d63-44bc-b975-9b6ae3440dde PaginationLink: description: >- Pagination cursor information, with the following link relations: `first` — URL of the first page; `self` — URL of the current page; `next` — URL of the next page (omitted on the last page). Pagination is forward-only. Always form follow-up calls from these URLs instead of constructing your own. schema: type: string example: >- ; rel="next" schemas: ListPartnerClientsResponse: type: object properties: data: type: array description: One page of clients, newest first. items: $ref: '#/components/schemas/PartnerClient' PartnerClient: type: object description: >- A client created under your partner account. `clientEntityId` and `created` are always present. The profile fields (`clientName`, `country`, `clientType`, `businessDetails`) echo the details submitted at creation, while `status` and `balances` are enriched by Circle and omitted when not available. required: - clientEntityId - created properties: clientEntityId: type: string format: uuid description: >- Unique identifier for the client entity, as returned by the create partner client endpoint. example: 880e8400-e29b-41d4-a716-446655440099 clientName: type: string description: Name of the client entity, as submitted at creation. example: Acme Trust Co. country: type: string description: >- ISO 3166-1 alpha-2 country code for the client's primary jurisdiction, as submitted at creation. example: US minLength: 2 maxLength: 2 clientType: type: string description: Type of client. enum: - business example: business businessDetails: $ref: '#/components/schemas/BusinessDetails' status: type: string description: >- Onboarding/compliance lifecycle status of the client, derived from Circle's partner-client compliance mapping. example: pending created: type: string format: date-time description: >- RFC 3339 / ISO 8601 timestamp for when the partner-client mapping was created. Always returned. example: '2026-06-16T14:39:03Z' balances: type: array description: >- Available balances for the client, grouped by currency. Returned as an empty array when the client has no balances; a single client may have multiple balances across currencies. items: $ref: '#/components/schemas/Money' example: - amount: '100.00' currency: USD BusinessDetails: type: object description: >- Business-specific details. On create, required only when `clientType` is `business` — omit this object for non-business client types. On reads, returned for business clients with the values submitted at creation. required: - institutionType - natureOfBusiness properties: natureOfBusiness: type: string description: >- Industry classification for the business. Determines which sections and fields appear in the onboarding application. enum: - accommodation - accounting - agriculture - art - assetManager - banking - brokerageOTC - construction - cryptoATM - cryptoCustodian - cryptoExchange - cryptoInvesting - cryptoSoftwareProvider - daOrg - dexAdmin - eCommercePlatform - education - familyOffice - film - healthCare - hedgeFund - insurance - manufacturingAutomobiles - manufacturingElectronics - manufacturingHighValueGoods - manufacturingOther - marketMaker - marketing - mining - miningPool - nftMarketplace - nonProfit - otherCryptoServices - otherOperatingCompanies - otherPooledInvestmentVehicles - p2p - paymentProcessorPlatform - personalInvestment - privateEquityFund - privateFoundation - publicCharity - realEstate - stakingServices - tokenProject - trading - transportation - trust - utilities - ventureCapitalFund - web3GamingSocial example: paymentProcessorPlatform institutionType: type: string description: Legal entity type of the business. enum: - associationOrConsortium - coop - foundation - governmentBody - partnership - privateCo - publicCo - soleTrader - trust example: privateCo Money: type: object description: A monetary amount in a specific currency. required: - amount - currency properties: amount: type: string description: Decimal amount as a string, to preserve precision. example: '100.00' currency: type: string description: ISO 4217 currency code. minLength: 3 maxLength: 3 example: USD responses: BadRequest: description: >- The request parameters are invalid — for example, `pageSize` outside the range 1 to 100, or a `pageAfter` cursor that does not reference a known client. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: type: object title: BadRequest required: - code - message properties: code: type: integer example: 400 message: type: string example: Invalid pagination parameters. NotAuthorized: description: >- The request has not been applied because it lacks valid authentication credentials. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: type: object title: NotAuthorized required: - code - message properties: code: type: integer example: 401 message: type: string example: Malformed authorization. Forbidden: description: >- The request provides authentication, but the authenticated user does not possess sufficient permissions for accessing this resource. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: type: object title: Forbidden required: - code - message properties: code: type: integer example: 403 message: type: string example: Forbidden securitySchemes: bearerAuth: type: http scheme: bearer ````