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

# List clients

> List the workspace's clients ordered by name. Without `page` or `page_size`, the response holds every record on one page. When you send either one, the list is paginated: 30 per page by default and up to 100.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain.md).


## OpenAPI

````yaml bundled/clients.yaml GET /clients
openapi: 3.0.3
info:
  title: NeetoInvoice APIs
  version: 2.0.0
servers:
  - description: NeetoInvoice APIs
    url: https://{your-subdomain}.neetoinvoice.com/api/external/v2
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/api/workspace-subdomain).
security: []
paths:
  /clients:
    get:
      tags:
        - Clients
      summary: List clients
      description: >-
        List the workspace's clients ordered by name. Without `page` or
        `page_size`, the response holds every record on one page. When you send
        either one, the list is paginated: 30 per page by default and up to 100.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - in: query
          name: status
          description: Only clients with this status.
          required: false
          schema:
            type: string
            enum:
              - active
              - archived
          example: active
        - in: query
          name: name
          description: >-
            Only clients whose name contains this text. The match is
            case-insensitive.
          required: false
          schema:
            type: string
          example: acme
        - $ref: '#/components/parameters/page_param'
        - $ref: '#/components/parameters/page_size_param'
      responses:
        '200':
          description: OK - Request succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/clients_list_response'
components:
  parameters:
    api_key_header:
      in: header
      name: X-Api-Key
      description: >-
        Use the X-Api-Key header to provide your workspace API key. Refer to
        [Authentication](/api/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
    page_param:
      in: query
      name: page
      description: >-
        Page of results to retrieve, starting from 1. Defaults to 1 when
        omitted.
      required: false
      schema:
        type: integer
      example: 1
    page_size_param:
      in: query
      name: page_size
      description: Number of results per page. Defaults to 30 when omitted.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
  schemas:
    clients_list_response:
      allOf:
        - $ref: '#/components/schemas/list_pagination_fields'
        - type: object
          properties:
            clients:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  identifier:
                    type: string
                    example: a8b90a464cad12b48e45
                  name:
                    type: string
                  secondary_name:
                    type: string
                    nullable: true
                  status:
                    type: string
                    enum:
                      - active
                      - archived
                  currency:
                    type: string
                    example: USD
                  default_invoice_due_in_days:
                    type: integer
                    example: 30
    list_pagination_fields:
      type: object
      properties:
        total_count:
          type: integer
          description: Total number of records across all pages.
          example: 1
        page:
          type: integer
          description: Current page number.
          example: 1
        page_size:
          type: integer
          description: Number of records per page.
          example: 30
        total_pages:
          type: integer
          description: Total number of pages.
          example: 1
        next_page:
          type: integer
          nullable: true
          description: Next page number, or null on the last page.
          example: null
        prev_page:
          type: integer
          nullable: true
          description: Previous page number, or null on the first page.
          example: null

````

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