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

# List clients

> Requires the `clients:read` scope (קריאת לקוחות).



## OpenAPI

````yaml /api-reference/openapi.json get /v1/clients
openapi: 3.1.0
info:
  title: Lancer API
  version: 1.0.0
  description: >-
    The Lancer public REST API. Authenticate with an organization API key
    (Settings → API & Webhooks) as `Authorization: Bearer lk_…` or `X-Api-Key`.
    Every key has scopes; each operation names the one it needs. Money is
    integer agorot (1 ₪ = 100). Lists are paginated with `page` and `pageSize`
    (max 100).
  contact:
    name: Lancer
    url: https://docs.lancer-erp.com
servers:
  - url: https://api.lancer-erp.com/api
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Leads
    description: >-
      Push leads into the sales pipeline from website forms, ad platforms, n8n
      or Make.
  - name: Clients
    description: Read and create clients (the businesses and people you bill).
  - name: Projects
    description: Read projects, their status and billing.
  - name: Payment requests
    description: Read and create payment requests, optionally with a hosted pay link.
  - name: Payments
    description: Read payments received.
paths:
  /v1/clients:
    get:
      tags:
        - Clients
      summary: List clients
      description: Requires the `clients:read` scope (קריאת לקוחות).
      operationId: getVClients
      parameters:
        - name: page
          in: query
          required: false
          schema:
            default: 1
            type: integer
            minimum: 1
            maximum: 9007199254740991
        - name: pageSize
          in: query
          required: false
          schema:
            default: 25
            type: integer
            minimum: 1
            maximum: 100
        - name: q
          in: query
          required: false
          schema:
            type: string
            maxLength: 200
        - name: includeArchived
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        type:
                          type: string
                          enum:
                            - company
                            - individual
                        name:
                          type: string
                        taxId:
                          type:
                            - string
                            - 'null'
                        phone:
                          type:
                            - string
                            - 'null'
                        email:
                          type:
                            - string
                            - 'null'
                        website:
                          type:
                            - string
                            - 'null'
                        address:
                          type:
                            - string
                            - 'null'
                        source:
                          type: string
                          enum:
                            - website
                            - api
                            - whatsapp
                            - sms
                            - referral
                            - manual
                            - meta_ads
                            - google_ads
                            - booking
                        tags:
                          type: array
                          items:
                            type: string
                        ownerId:
                          anyOf:
                            - type: string
                              minLength: 1
                            - type: 'null'
                        contacts:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              title:
                                type:
                                  - string
                                  - 'null'
                              email:
                                type:
                                  - string
                                  - 'null'
                              phone:
                                type:
                                  - string
                                  - 'null'
                              isPrimary:
                                type: boolean
                            required:
                              - name
                              - title
                              - email
                              - phone
                              - isPrimary
                            additionalProperties: false
                        customFields:
                          default: {}
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type:
                              - string
                              - number
                              - boolean
                              - 'null'
                        archived:
                          type: boolean
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                      required:
                        - id
                        - type
                        - name
                        - taxId
                        - phone
                        - email
                        - website
                        - address
                        - source
                        - tags
                        - ownerId
                        - contacts
                        - customFields
                        - archived
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                  total:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  page:
                    type: integer
                    minimum: 1
                    maximum: 9007199254740991
                  pageSize:
                    type: integer
                    minimum: 1
                    maximum: 9007199254740991
                required:
                  - items
                  - total
                  - page
                  - pageSize
                additionalProperties: false
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                additionalProperties: false
        '401':
          description: Missing, unknown or revoked API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                additionalProperties: false
        '403':
          description: The key lacks the scope (code INSUFFICIENT_SCOPE)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                additionalProperties: false
        '404':
          description: Not found in this organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                additionalProperties: false
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: lk_…
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-Api-Key

````

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