> ## 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.

# List counterparty summaries

> Return workspace counterparty summaries with a pagination cursor and optional saved addresses.

Related: [Onboard a counterparty](https://docs.range.org/platform-api/guides/onboard-a-counterparty.md).


## OpenAPI

````yaml api-reference/platform-api.json get /v2/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.37
  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.
  - name: Parties
    description: >-
      The workspace entity register: the firm itself, its clients, and its
      counterparties.
paths:
  /v2/counterparties:
    get:
      tags:
        - Counterparties
      summary: List counterparties
      operationId: list
      parameters:
        - name: type
          required: false
          in: query
          description: Filter by relationship type
          schema:
            type: string
            example: vendor
            enum:
              - vendor
              - customer
              - investor
              - partner
              - exchange
              - other
        - name: search
          required: false
          in: query
          description: Search by name
          schema:
            type: string
            example: Vercel
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 200
            default: 50
            example: 50
            type: number
        - name: cursor
          required: false
          in: query
          description: Pagination cursor
          schema:
            type: string
        - name: include_addresses
          required: false
          in: query
          description: 'Include each counterparty''s saved addresses inline (default: false)'
          schema:
            default: false
            type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CounterpartyListResponseDto'
components:
  schemas:
    CounterpartyListResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CounterpartySummaryDto'
        meta:
          $ref: '#/components/schemas/CursorMetaDto'
      required:
        - items
        - meta
    CounterpartySummaryDto:
      type: object
      properties:
        id:
          type: string
          example: a1b2c3d4-5678-90ab-cdef-1234567890ab
        name:
          type: string
          example: Vercel
        type:
          type: string
          example: vendor
        website:
          type: string
          example: https://vercel.com
        addresses:
          example: >-
            0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045,CCTPiPYPc6AsJuwueEnWgSgucamXDZwBd53dQ11YiKX3
          description: Present only when the request set `include_addresses=true`
          type: array
          items:
            $ref: '#/components/schemas/CounterpartyAddressDto'
        created_at:
          type: string
          example: '2026-05-01T10:00:00Z'
        updated_at:
          type: string
          example: '2026-05-11T14:30:00Z'
      required:
        - id
        - name
        - type
        - created_at
        - updated_at
    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 (1-based). Omitted by list endpoints that do not
            compute a page index.
          example: 1
    CounterpartyAddressDto:
      type: object
      properties:
        id:
          type: string
          example: 08846e81-b3a8-7fd9-cc39-d4023a75dcff
        address:
          type: string
          example: '0x742d35Cc6634C0532925a3b844Bc9e7595f2bD28'
        network:
          type: string
          example: ethereum
          description: >-
            Network identifier, always lowercased regardless of the casing it
            was submitted with.
        label:
          type: string
          example: payment address
      required:
        - id
        - address
        - network
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.