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

# Lire un client

> **Accès** : `customers.read`

Renvoie un client visible par la clé, dans la même représentation que la liste, sans historique de locations. Hors du périmètre de la clé : 404.



## OpenAPI

````yaml /openapi.json get /customers/{customerId}
openapi: 3.1.0
info:
  title: API Lexio
  version: 1.0.1
  description: >-
    # API Lexio v1


    L’API Lexio permet à un loueur de véhicules, ou à une plateforme partenaire
    autorisée par lui, de chiffrer, réserver, suivre et administrer ses
    locations depuis un serveur. Chaque appel agit sur l’organisation Lexio d’un
    seul loueur.


    - **Adresse de base** : `https://api.lexio.rent/api/external/v1`

    - **Authentification** : `Authorization: Bearer lck_…`, une clé créée par le
    loueur dans Lexio.

    - **Format** : JSON en UTF-8 ; erreurs RFC 9457 avec un `code` stable.

    - **Spécification OpenAPI 3.1** :
    [https://docs.lexio.rent/openapi.json](https://docs.lexio.rent/openapi.json),
    à importer dans votre client HTTP ou à utiliser pour générer un client.

    - **Contact** (support technique, demande d’accès, organisation de test) :
    contact@lexio.rent.


    Vocabulaire : une **location** (`/rentals`) est un contrat de location d’un
    véhicule ; un **lieu** (`/locations`) est une adresse de départ ou de
    retour.


    ## Guides


    1. [Démarrage rapide](https://docs.lexio.rent/demarrage-rapide) : de la
    recherche d’un véhicule à l’annulation.

    2. [Authentification et scopes](https://docs.lexio.rent/authentification) :
    clés du loueur et clés partenaires, scopes, plans.

    3. [Montants et TVA](https://docs.lexio.rent/montants-et-tva) : HT, TTC,
    devises, caution et franchise.

    4. [Cycle de vie d’une location](https://docs.lexio.rent/cycle-de-vie) :
    statuts et actions possibles.

    5. [Limites de débit](https://docs.lexio.rent/limites),
    [Pagination](https://docs.lexio.rent/pagination), [Idempotence et
    reprise](https://docs.lexio.rent/idempotence).

    6. [Synchronisation par événements](https://docs.lexio.rent/synchronisation)
    : suivre les changements sans webhook.

    7. [Versions et évolutions](https://docs.lexio.rent/versions),
    [Erreurs](https://docs.lexio.rent/erreurs).

    8. [Intégration d’une plateforme de
    réservation](https://docs.lexio.rent/integration-broker) : parcours
    partenaire, paiement.

    9. [Ce qui se gère dans
    Lexio](https://docs.lexio.rent/ce-qui-se-gere-dans-lexio) et [Historique des
    versions](https://docs.lexio.rent/historique).
  contact:
    name: Support Lexio
    email: contact@lexio.rent
    url: https://docs.lexio.rent
servers:
  - url: https://api.lexio.rent/api/external/v1
    description: Production
security:
  - ApiKey: []
tags:
  - name: Organisation
    description: >-
      Réglages de l’organisation liée à la clé : devise, fuseau, TVA, horaires,
      règles de réservation.
  - name: Offre
    description: >-
      Disponibilités et devis : ce qui est réservable, à quel prix, avant de
      créer une location.
  - name: Locations
    description: >-
      Les contrats de location : création, lecture, modification de notes,
      suppression.
  - name: Modifications
    description: >-
      Changer les dates, le véhicule, la protection, le titulaire ou les options
      d’une location, ou l’annuler.
  - name: Départ et retour
    description: >-
      Remise des clés et retour du véhicule : kilométrage, carburant, photos,
      état des lieux.
  - name: Paiements
    description: Encaissements, cautions et remboursements enregistrés sur une location.
  - name: Événements
    description: >-
      Flux des changements à relire pour synchroniser votre système, sans
      webhook.
  - name: Clients
    description: Fiches des clients particuliers et entreprises.
  - name: Flotte
    description: Véhicules, leur archivage et leurs indisponibilités.
  - name: Catalogue
    description: >-
      Catégories, lieux, options, franchises, cautions et forfaits kilométriques
      proposés à la location.
  - name: Tarification
    description: Saisons, remises de durée, paliers de délai et réglages de prix.
  - name: Entretien
    description: Alertes et historique d’entretien des véhicules.
paths:
  /customers/{customerId}:
    get:
      tags:
        - Clients
      summary: Lire un client
      description: >-
        **Accès** : `customers.read`


        Renvoie un client visible par la clé, dans la même représentation que la
        liste, sans historique de locations. Hors du périmètre de la clé : 404.
      operationId: getCustomer
      parameters:
        - in: path
          name: customerId
          schema:
            examples:
              - 7c9e6679-7425-40de-944b-e07fc1f90ae7
            type: string
            format: uuid
          required: true
          description: Identifiant de la fiche client.
      responses:
        '200':
          description: Lire un client
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Customer'
                required:
                  - data
        '400':
          description: '`VALIDATION_FAILED`'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationFailedProblem'
        '401':
          description: >-
            `API_KEY_DISABLED`, `API_KEY_EXPIRED`, `API_KEY_INVALID`,
            `API_KEY_MISSING`, `API_KEY_REVOKED`
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            WWW-Authenticate:
              $ref: '#/components/headers/WwwAuthenticate'
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ApiKeyDisabledProblem'
                  - $ref: '#/components/schemas/ApiKeyExpiredProblem'
                  - $ref: '#/components/schemas/ApiKeyInvalidProblem'
                  - $ref: '#/components/schemas/ApiKeyMissingProblem'
                  - $ref: '#/components/schemas/ApiKeyRevokedProblem'
        '403':
          description: >-
            `FEATURE_NOT_AVAILABLE`, `INSUFFICIENT_SCOPE`,
            `ORGANIZATION_SUSPENDED`
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/FeatureNotAvailableProblem'
                  - $ref: '#/components/schemas/InsufficientScopeProblem'
                  - $ref: '#/components/schemas/OrganizationSuspendedProblem'
        '404':
          description: '`NOT_FOUND`'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/NotFoundProblem'
        '429':
          description: '`RATE_LIMITED`'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/RateLimitedProblem'
        '500':
          description: '`INTERNAL_ERROR`'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/InternalErrorProblem'
      security:
        - ApiKey: []
components:
  headers:
    XRequestId:
      description: Identifiant de la requête, à communiquer au support.
      schema:
        type: string
    RateLimitLimit:
      description: Plafond du seau de débit qui s’applique à la requête.
      schema:
        type: integer
        minimum: 0
    RateLimitRemaining:
      description: Requêtes encore permises dans la fenêtre en cours.
      schema:
        type: integer
        minimum: 0
    RateLimitReset:
      description: Secondes avant la remise à zéro de la fenêtre.
      schema:
        type: integer
        minimum: 0
    WwwAuthenticate:
      description: >-
        Schéma d’authentification attendu (`Bearer`), avec
        `error="invalid_token"` pour une clé refusée.
      schema:
        type: string
    RetryAfter:
      description: Secondes à attendre avant de rejouer la requête.
      schema:
        type: integer
        minimum: 0
  schemas:
    Customer:
      examples:
        - id: 2c9d4e7a-8b1f-4a3c-9e5d-6f7a8b9c0d1e
          isCompany: false
          partnerCode: null
          firstName: Marie
          lastName: MARTIN
          companyName: null
          email: marie.martin@example.com
          phone: '+33612345678'
          birthDate: '1988-04-22'
          birthCity: Lyon
          nationality: Française
          licenseNumber: 12AB34567
          licenseIssueDate: '2007-09-14'
          address:
            street: 12 rue de France
            complement: null
            postalCode: '06000'
            city: Nice
            country: FR
          companyRegistrationNumber: null
          companyEstablishmentNumber: null
          vatNumber: null
          acquisitionSource: ONLINE
          isBlocked: false
          anonymizedAt: null
          createdAt: '2026-11-03T14:27:05+01:00'
          updatedAt: '2026-11-03T14:27:05+01:00'
      type: object
      properties:
        id:
          examples:
            - 7c9e6679-7425-40de-944b-e07fc1f90ae7
          description: Identifiant du client.
          type: string
          format: uuid
        isCompany:
          description: >-
            true : société ; false : particulier. Les champs de l’autre type
            valent null.
          type: boolean
        partnerCode:
          description: >-
            Code partenaire de la clé qui a créé le client ; null pour un client
            de l’agence. Une clé partenaire ne voit que les clients de son code.
          anyOf:
            - type: string
              maxLength: 50
            - type: 'null'
        firstName:
          description: >-
            Prénom (particulier) ; null pour une société ou une fiche
            anonymisée.
          anyOf:
            - type: string
            - type: 'null'
        lastName:
          description: >-
            Nom de famille (particulier), publié en majuscules ; null pour une
            société ou une fiche anonymisée.
          anyOf:
            - type: string
            - type: 'null'
        companyName:
          description: Raison sociale (société) ; null pour un particulier.
          anyOf:
            - type: string
            - type: 'null'
        email:
          description: >-
            Email, en minuscules ; celui d’un particulier est unique pour un
            même `partnerCode`. null si absent.
          anyOf:
            - type: string
            - type: 'null'
        phone:
          description: >-
            Téléphone, au format international quand le pays est connu ; null si
            absent.
          anyOf:
            - type: string
            - type: 'null'
        birthDate:
          description: Date de naissance (particulier), `YYYY-MM-DD`.
          anyOf:
            - examples:
                - '2026-11-10'
              type: string
              format: date
            - type: 'null'
        birthCity:
          description: Lieu de naissance (particulier).
          anyOf:
            - type: string
            - type: 'null'
        nationality:
          description: Nationalité, en texte libre (particulier).
          anyOf:
            - type: string
            - type: 'null'
        licenseNumber:
          description: Numéro du permis de conduire (particulier).
          anyOf:
            - type: string
            - type: 'null'
        licenseIssueDate:
          description: >-
            Date de délivrance du permis de conduire (particulier),
            `YYYY-MM-DD`.
          anyOf:
            - examples:
                - '2026-11-10'
              type: string
              format: date
            - type: 'null'
        address:
          description: Adresse postale ; null si aucune.
          anyOf:
            - type: object
              properties:
                street:
                  description: Numéro et voie.
                  anyOf:
                    - type: string
                    - type: 'null'
                complement:
                  description: Complément d’adresse (bâtiment, étage…).
                  anyOf:
                    - type: string
                    - type: 'null'
                postalCode:
                  description: Code postal.
                  anyOf:
                    - type: string
                    - type: 'null'
                city:
                  description: Ville.
                  anyOf:
                    - type: string
                    - type: 'null'
                country:
                  description: >-
                    Pays, code ISO 3166-1 alpha-2 ; null pour une ancienne
                    valeur illisible.
                  anyOf:
                    - type: string
                      pattern: ^[A-Z]{2}$
                    - type: 'null'
              required:
                - street
                - complement
                - postalCode
                - city
                - country
            - type: 'null'
        companyRegistrationNumber:
          description: >-
            Numéro d’immatriculation de la société. En France et dans les DROM :
            SIREN, 9 chiffres, requis pour une société ; ailleurs, format du
            pays. Pays : celui de l’adresse, sinon celui de l’agence.
          anyOf:
            - type: string
            - type: 'null'
        companyEstablishmentNumber:
          description: 'Numéro de l’établissement (en France : SIRET, 14 chiffres).'
          anyOf:
            - type: string
            - type: 'null'
        vatNumber:
          description: Numéro de TVA intracommunautaire de la société.
          anyOf:
            - type: string
            - type: 'null'
        acquisitionSource:
          description: Canal par lequel le client est arrivé. null si inconnu.
          anyOf:
            - type: string
              enum:
                - ONLINE
                - PHONE
                - WALKIN
                - PARTNER
                - OTHER
            - type: 'null'
        isBlocked:
          description: >-
            true : client bloqué par l’agence, une nouvelle location à son nom
            est refusée.
          type: boolean
        anonymizedAt:
          description: >-
            Date de l’anonymisation : données personnelles effacées, fiche en
            lecture seule. null sinon.
          anyOf:
            - examples:
                - '2026-11-10T10:00:00+01:00'
              type: string
              format: date-time
            - type: 'null'
        createdAt:
          examples:
            - '2026-11-10T10:00:00+01:00'
          description: Création, heure de l’agence avec décalage.
          type: string
          format: date-time
        updatedAt:
          examples:
            - '2026-11-10T10:00:00+01:00'
          description: Dernière modification.
          type: string
          format: date-time
      required:
        - id
        - isCompany
        - partnerCode
        - firstName
        - lastName
        - companyName
        - email
        - phone
        - birthDate
        - birthCity
        - nationality
        - licenseNumber
        - licenseIssueDate
        - address
        - companyRegistrationNumber
        - companyEstablishmentNumber
        - vatNumber
        - acquisitionSource
        - isBlocked
        - anonymizedAt
        - createdAt
        - updatedAt
    ValidationFailedProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/validation-failed
        title:
          type: string
          const: Requête invalide
        status:
          type: number
          const: 400
        code:
          type: string
          const: VALIDATION_FAILED
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
        errors:
          minItems: 1
          maxItems: 100
          type: array
          items:
            type: object
            properties:
              pointer:
                type: string
              code:
                type: string
                enum:
                  - required
                  - invalid_type
                  - invalid_format
                  - invalid_value
                  - too_small
                  - too_big
                  - too_many_decimals
                  - out_of_range
                  - unknown_field
                  - null_not_allowed
                  - empty_string
                  - empty_patch
                  - mutually_exclusive
                  - not_applicable
                  - duplicate
                  - end_before_start
                  - date_in_past
                  - nonexistent_local_time
                  - offset_not_allowed
                  - offset_required
                  - upload_expired
                  - upload_incomplete
                  - upload_conflict
              detail:
                type: string
            required:
              - pointer
              - code
              - detail
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
        - errors
    ApiKeyDisabledProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/api-key-disabled
        title:
          type: string
          const: Clé API désactivée
        status:
          type: number
          const: 401
        code:
          type: string
          const: API_KEY_DISABLED
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
    ApiKeyExpiredProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/api-key-expired
        title:
          type: string
          const: Clé API expirée
        status:
          type: number
          const: 401
        code:
          type: string
          const: API_KEY_EXPIRED
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
    ApiKeyInvalidProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/api-key-invalid
        title:
          type: string
          const: Clé API invalide
        status:
          type: number
          const: 401
        code:
          type: string
          const: API_KEY_INVALID
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
    ApiKeyMissingProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/api-key-missing
        title:
          type: string
          const: Clé API absente
        status:
          type: number
          const: 401
        code:
          type: string
          const: API_KEY_MISSING
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
    ApiKeyRevokedProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/api-key-revoked
        title:
          type: string
          const: Clé API révoquée
        status:
          type: number
          const: 401
        code:
          type: string
          const: API_KEY_REVOKED
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
    FeatureNotAvailableProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/feature-not-available
        title:
          type: string
          const: Fonctionnalité non incluse
        status:
          type: number
          const: 403
        code:
          type: string
          const: FEATURE_NOT_AVAILABLE
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
        feature:
          type: string
          minLength: 1
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
        - feature
    InsufficientScopeProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/insufficient-scope
        title:
          type: string
          const: Scope insuffisant
        status:
          type: number
          const: 403
        code:
          type: string
          const: INSUFFICIENT_SCOPE
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
        requiredScopes:
          minItems: 1
          maxItems: 20
          type: array
          items:
            type: string
            enum:
              - offers.read
              - quotes.write
              - rentals.read
              - rentals.write
              - rentals.operate
              - rentals.delete
              - payments.write
              - payments.refund
              - customers.read
              - customers.write
              - customers.delete
              - vehicles.read
              - vehicles.write
              - vehicles.delete
              - catalog.read
              - catalog.write
              - pricing.read
              - pricing.write
              - maintenance.read
              - maintenance.write
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
        - requiredScopes
    OrganizationSuspendedProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/organization-suspended
        title:
          type: string
          const: Organisation suspendue
        status:
          type: number
          const: 403
        code:
          type: string
          const: ORGANIZATION_SUSPENDED
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
    NotFoundProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/not-found
        title:
          type: string
          const: Ressource introuvable
        status:
          type: number
          const: 404
        code:
          type: string
          const: NOT_FOUND
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
        resource:
          type: string
          enum:
            - RENTAL
            - RENTAL_OPTION
            - QUOTE
            - PAYMENT
            - INVOICE
            - PHOTO
            - AMENDMENT
            - INSPECTION
            - CUSTOMER
            - VEHICLE
            - VEHICLE_BLOCK
            - CATEGORY
            - OPTION
            - DEDUCTIBLE
            - DEPOSIT
            - MILEAGE_PACKAGE
            - LOCATION
            - SEASON
            - SEASON_CALENDAR_MONTH
            - DURATION_DISCOUNT
            - LEAD_TIME_TIER
            - MAINTENANCE_RECORD
            - MAINTENANCE_OPERATION
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
        - resource
    RateLimitedProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/rate-limited
        title:
          type: string
          const: Trop de requêtes
        status:
          type: number
          const: 429
        code:
          type: string
          const: RATE_LIMITED
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
        limit:
          type: string
          enum:
            - PRE_AUTH
            - PER_KEY
            - WRITE
            - QUOTE
        windowSeconds:
          type: integer
          minimum: 1
        retryAfter:
          type: integer
          minimum: 0
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
        - limit
        - windowSeconds
        - retryAfter
    InternalErrorProblem:
      type: object
      properties:
        type:
          type: string
          const: https://api.lexio.rent/errors/internal-error
        title:
          type: string
          const: Erreur interne
        status:
          type: number
          const: 500
        code:
          type: string
          const: INTERNAL_ERROR
        detail:
          type: string
        instance:
          type: string
        requestId:
          type: string
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: lck_…
      description: >-
        Clé API `lck_…` créée dans Lexio (Paramètres → Développeur), envoyée en
        `Authorization: Bearer`. Voir
        [Authentification](https://docs.lexio.rent/authentification).

````

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