> ## Documentation Index
> Fetch the complete documentation index at: https://docs.range.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Pull counterparty candidates from a ledger connection

> Preview-only list of customers/vendors from the linked bookkeeping system (e.g. QuickBooks). Does not write to `counterparties` — persist via POST /v2/counterparties. Active records only — inactive/archived customers and vendors are omitted (MVP default).



## OpenAPI

````yaml /api-reference/platform-api.json get /v2/account-connections/bookkeeping/{connectionId}/counterparties
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.15
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
paths:
  /v2/account-connections/bookkeeping/{connectionId}/counterparties:
    get:
      tags:
        - Account Connections
      summary: Pull counterparty candidates from a ledger connection
      description: >-
        Preview-only list of customers/vendors from the linked bookkeeping
        system (e.g. QuickBooks). Does not write to `counterparties` — persist
        via POST /v2/counterparties. Active records only — inactive/archived
        customers and vendors are omitted (MVP default).
      operationId: listCounterparties
      parameters:
        - name: connectionId
          required: true
          in: path
          schema:
            type: string
        - name: cursor
          required: false
          in: query
          description: Opaque cursor returned in meta.next_cursor of a previous response.
          schema:
            type: string
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 50
            example: 50
            type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBookkeepingCounterpartiesResponseDto'
components:
  schemas:
    ListBookkeepingCounterpartiesResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BookkeepingCounterpartyCandidateDto'
        meta:
          $ref: '#/components/schemas/CursorMetaDto'
      required:
        - items
        - meta
    BookkeepingCounterpartyCandidateDto:
      type: object
      properties:
        external_id:
          type: string
          description: Upstream id (QuickBooks Customer/Vendor Id, …)
          example: '58'
        name:
          type: string
          example: Acme Supplies
        type:
          type: string
          example: vendor
          enum:
            - vendor
            - customer
            - investor
            - partner
            - exchange
            - other
        website:
          type: string
          example: https://acme.example
        notes:
          type: string
      required:
        - external_id
        - name
        - type
    CursorMetaDto:
      type: object
      properties:
        next_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the next page of results. null if
            there is no next page.
          example: eyJpZCI6IjkxeFFlV3Z...
        previous_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the previous page of results. null
            if there is no previous page.
          example: eyJpZCI6IjkxeFFlV3Z...
        first_page_cursor:
          type: string
          description: >-
            Opaque string cursor pointing to the very first page in the entire
            dataset with respect to the current filter.
          example: eyJpZCI6IjkxeFFlV3Z...
        last_page_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the very last page in the entire
            dataset with respect to the current filter.
          example: eyJpZCI6IjkxeFFlV3Z...
        total_count:
          type: number
          nullable: true
          description: Total number of results.
          example: 100
        page_number:
          type: number
          description: Current page number.
          example: 1
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````