Query parameters

• limit integer

  Nombre maximum de clients à retourner

  Default value is 20.

• skip integer

  Nombre de clients à ignorer (pagination)

  Default value is 0.

• sort string

  Champ et direction de tri (ex. "name:1" pour tri alphabétique)

• state string

  Filtrer par état (active = visible, inactive = archivé)

  Values are active or inactive.

• search string

  Recherche textuelle dans nom, email, téléphone, code client

Responses

• 200 application/json

  Liste des clients avec pagination

  Hide response attributes Show response attributes object

  • clients array[object]

    Tableau des clients

    Hide clients attributes Show clients attributes object

    • _id string

      Unique identifier for the client

    • name string

      Name of the client (required)

    • email string(email)

      Email of the client

    • phone string

      Phone number

    • phoneFormat string

      Formatted phone number for search

    • mobile string

      Mobile phone number

    • mobileFormat string

      Formatted mobile number for search

    • fax string

      Fax number

    • address string

      Street address

    • address_complement string

      Address complement

    • address_end string

      Additional address information

    • zip_code string

      Zip code

    • city string

      City

    • country string

      Country

      Default value is France.

    • company string

      Reference to the company

    • category string

      Client category

    • client_code string

      Client code for accounting

    • analytical_code string

      Analytical code

    • siren string

      SIREN number

    • nic string

      NIC code

    • tva_number string

      VAT number

    • website string

      Website URL

    • description string

      Client description

    • notes string

      Notes about the client

    • avatar object

      Client avatar image

    • client_contact string

      Reference to main contact interlocutor

    • mainInterlocutor string

      Reference to main interlocutor

    • positionsAssigned array[string]

      List of assigned positions

    • positionCreator string

      Position that created this client

    • positionLastUpdator string

      Position that last updated this client

    • tags array[string]

      List of tag references

    • state string

      Client state

      Values are active or inactive. Default value is active.

    • stats object
      Hide stats attributes Show stats attributes object

      • nbInvoices integer

        Default value is 0.

      • nbNotes integer

        Default value is 0.

      • nbReminders integer

        Default value is 0.

      • nbFiles integer

        Default value is 0.

      • nbPurchases integer

        Default value is 0.

      • nbQuotes integer

        Default value is 0.

      • nbDeliveryReceipts integer

        Default value is 0.

    • extraData object

      Custom extra data

    • createdAt string(date-time)
    • updatedAt string(date-time)
  • total integer

    Nombre total de clients

  • limit integer

    Limite utilisée

  • skip integer

    Offset utilisé