> ## Documentation Index
> Fetch the complete documentation index at: https://alpha.developer.tomorro.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List counterparties

> Returns a paginated list of counterparties in your organization. Supports cursor-based pagination, sorting, and filtering.



## OpenAPI

````yaml /openapi-2025-01-15.init.json get /counterparties
openapi: 3.0.0
info:
  title: Tomorro API
  description: >
    The Tomorro Public API enables you to programmatically manage contracts,
    members, and counterparties. Build powerful integrations that automate your
    contract management workflows.


    ## API Version: 2025-01-15.init


    This documentation is for API version `2025-01-15.init`.


    > **Warning:** This version is deprecated. This version is deprecated.
    Please upgrade to 2025-01-29.alpha.


    ### Using this version

    ```

    curl -X GET https://api.tomorro.com/members \
      -H "x-api-key: YOUR_API_KEY" \
      -H "tomorro-version: 2025-01-15.init"
    ```
  version: 2025-01-15.init
  contact: {}
servers:
  - url: https://api.tomorro.com/v2
    description: Production
  - url: https://api.demo.tomorro.com/v2
    description: Demo
  - url: http://localhost:3015
    description: Local Development
security: []
tags: []
paths:
  /counterparties:
    get:
      tags:
        - Counterparties
      summary: List counterparties
      description: >-
        Returns a paginated list of counterparties in your organization.
        Supports cursor-based pagination, sorting, and filtering.
      operationId: CounterpartyController_listCounterparties
      parameters:
        - name: limit
          required: false
          in: query
          description: Number of items per page (1-50)
          schema:
            minimum: 1
            maximum: 50
            default: 20
            example: 20
            type: number
        - name: after
          required: false
          in: query
          description: >-
            Cursor for forward pagination. Use the `next_cursor` value from a
            previous response.
          schema:
            example: eyJpZCI6IjEyMyJ9
            type: string
        - name: before
          required: false
          in: query
          description: >-
            Cursor for backward pagination. Use the `prev_cursor` value from a
            previous response.
          schema:
            example: eyJpZCI6IjEwMCJ9
            type: string
        - name: sort
          required: false
          in: query
          description: >-
            Sort order. Comma-separated list of fields. Prefix with `-` for
            descending. Allowed fields: `id`, `name`, `status`, `createdAt`,
            `updatedAt`. Default: `-createdAt`
          schema:
            example: '-createdAt,name'
            type: string
        - name: status
          required: false
          in: query
          description: >-
            Filter by status. Formats: `status=active` (equality),
            `status=in:active,archived` (in list)
          schema:
            example: active
            type: string
        - name: name
          required: false
          in: query
          description: Filter by name. Partial match on the counterparty name.
          schema:
            example: Acme
            type: string
      responses:
        '200':
          description: List of counterparties with pagination info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CounterpartyListResponseDto'
        '401':
          description: Unauthorized - Invalid or missing API key
        '403':
          description: Forbidden - Insufficient permissions
        '429':
          description: Too Many Requests - Rate limit exceeded
      security:
        - X-API-KEY: []
components:
  schemas:
    CounterpartyListResponseDto:
      type: object
      properties:
        data:
          description: An array of Counterparty objects.
          example:
            - id: 550e8400-e29b-41d4-a716-446655440000
              name: Acme Corporation
              status: active
              logoUrl: https://example.com/logo.png
              fields:
                ff093e5d-39af-4cf6-8920-c07c9e3f5921: value1
              createdAt: '2024-01-01T00:00:00.000Z'
              updatedAt: '2024-01-02T00:00:00.000Z'
          type: array
          items:
            $ref: '#/components/schemas/CounterpartyResponseDto'
        pagination:
          description: Pagination metadata including cursors and navigation flags.
          example:
            limit: 20
            next_cursor: eyJpZCI6IjEyMyJ9
            prev_cursor: eyJpZCI6IjEwMCJ9
            has_next: true
            has_previous: false
          allOf:
            - $ref: '#/components/schemas/PaginationMetaDto'
        links:
          description: HATEOAS navigation links for pagination.
          example:
            self: /counterparties?limit=20
            next: /counterparties?limit=20&after=eyJpZCI6IjEyMyJ9
            prev: /counterparties?limit=20&before=eyJpZCI6IjEwMCJ9
          allOf:
            - $ref: '#/components/schemas/PaginationLinksDto'
      required:
        - data
        - pagination
        - links
    CounterpartyResponseDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the counterparty
          example: 550e8400-e29b-41d4-a716-446655440000
        name:
          type: string
          description: Name of the counterparty (company or individual name)
          example: Acme Corporation
        status:
          type: string
          description: Current status of the counterparty
          enum:
            - active
            - archived
          example: active
        logoUrl:
          type: string
          description: URL of the counterparty logo
          nullable: true
          example: https://example.com/logo.png
        fields:
          type: object
          description: Custom field values for the counterparty
          example:
            ff093e5d-39af-4cf6-8920-c07c9e3f5921: value1
        createdAt:
          format: date-time
          type: string
          description: >-
            Time at which the counterparty was created. Formatted as an ISO 8601
            date-time string.
          example: '2024-01-01T00:00:00.000Z'
        updatedAt:
          format: date-time
          type: string
          description: >-
            Time at which the counterparty was last updated. Formatted as an ISO
            8601 date-time string.
          example: '2024-01-02T00:00:00.000Z'
      required:
        - id
        - name
        - status
        - logoUrl
        - fields
        - createdAt
        - updatedAt
    PaginationMetaDto:
      type: object
      properties:
        limit:
          type: number
          description: The number of items per page.
          example: 20
        next_cursor:
          type: string
          description: >-
            Cursor for fetching the next page. Use with the `after` query
            parameter.
          nullable: true
          example: eyJpZCI6IjEyMyJ9
        prev_cursor:
          type: string
          description: >-
            Cursor for fetching the previous page. Use with the `before` query
            parameter.
          nullable: true
          example: eyJpZCI6IjEwMCJ9
        has_next:
          type: boolean
          description: Whether there are more items available after this page.
          example: true
        has_previous:
          type: boolean
          description: Whether there are items available before this page.
          example: false
      required:
        - limit
        - next_cursor
        - prev_cursor
        - has_next
        - has_previous
    PaginationLinksDto:
      type: object
      properties:
        self:
          type: string
          description: URL of the current page.
          example: /members?limit=20
        next:
          type: string
          description: URL to fetch the next page. Null if there is no next page.
          nullable: true
          example: /members?limit=20&after=eyJpZCI6IjEyMyJ9
        prev:
          type: string
          description: URL to fetch the previous page. Null if there is no previous page.
          nullable: true
          example: /members?limit=20&before=eyJpZCI6IjEwMCJ9
      required:
        - self
        - next
        - prev
  securitySchemes:
    X-API-KEY:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Get your key at
        https://app.tomorro.com/settings/integrations?integration=api-key

````