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

# Create a client

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



## OpenAPI

````yaml /api-reference/openapi.json post /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:
    post:
      tags:
        - Clients
      summary: Create a client
      description: Requires the `clients:write` scope (יצירת לקוחות).
      operationId: postVClients
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  default: company
                  type: string
                  enum:
                    - company
                    - individual
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                taxId:
                  type: string
                  maxLength: 20
                phone:
                  type: string
                  maxLength: 40
                email:
                  type: string
                website:
                  type: string
                address:
                  type: string
                  maxLength: 300
                source:
                  default: api
                  type: string
                  enum:
                    - website
                    - api
                    - whatsapp
                    - sms
                    - referral
                    - manual
                    - meta_ads
                    - google_ads
                    - booking
                tags:
                  default: []
                  maxItems: 20
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 40
                contacts:
                  maxItems: 20
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        minLength: 1
                        maxLength: 120
                      title:
                        type: string
                        maxLength: 120
                      email:
                        type: string
                      phone:
                        type: string
                        maxLength: 40
                    required:
                      - name
                customFields:
                  type: object
                  propertyNames:
                    type: string
                    maxLength: 40
                  additionalProperties:
                    type:
                      - string
                      - number
                      - boolean
                      - 'null'
              required:
                - name
            example:
              type: company
              name: Echo Studio Ltd.
              taxId: '515555555'
              email: billing@echo.example
              phone: 03-5551234
              tags:
                - retainer
              contacts:
                - name: Dana Levi
                  title: CEO
                  email: dana@echo.example
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                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
        '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.