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

# Get list of counterparties

> Retrieve a paginated list of counterparties.



## OpenAPI

````yaml get /v1/counterparties
openapi: 3.0.0
info:
  title: Counterparties API
  version: 1.0.0
servers:
  - url: https://api.nomi.tools
    description: Main API server
security:
  - basicAuth: []
paths:
  /v1/counterparties:
    get:
      tags:
        - Counterparties
      summary: Get list of counterparties
      description: Retrieve a paginated list of counterparties.
      operationId: getCounterparties
      parameters:
        - name: pagination
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/Pagination'
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
            default: application/json
      responses:
        '200':
          description: List of counterparties
          content:
            application/json:
              schema:
                type: object
                properties:
                  counterparties:
                    type: array
                    items:
                      $ref: '#/components/schemas/Counterparty'
                  meta:
                    $ref: '#/components/schemas/Metadata'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Pagination:
      type: object
      properties:
        page:
          type: integer
          description: Current page number.
        limit:
          type: integer
          description: Maximum number of items per page.
        offset:
          type: integer
          description: Offset for pagination.
    Counterparty:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the counterparty.
        name:
          type: string
          description: Name of the counterparty.
        externalId:
          type: string
          nullable: true
          description: External identifier for the counterparty.
        balance:
          type: number
          format: float
          description: Current balance of the counterparty.
        notes:
          type: string
          nullable: true
          description: Additional notes about the counterparty.
        isArchived:
          type: boolean
          description: Indicates if the counterparty is archived.
        types:
          type: array
          items:
            type: string
            enum:
              - client
              - supplier
              - partner
              - contractor
              - other
          description: Types associated with the counterparty.
    Metadata:
      type: object
      properties:
        total:
          type: integer
          description: Total number of items.
        limit:
          type: integer
          description: Maximum number of items per page.
        offset:
          type: integer
          description: Offset for pagination.
  responses:
    Unauthorized:
      description: Unauthorized access
    Forbidden:
      description: Forbidden access
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >
        Use HTTP Basic Authentication.  Provide your email as login and PPT
        token as the password.

````