# Get a customer

Returns detailed customer information.
Use `include` to load additional relations.
**Available includes:**
`address`, `groups`, `color`, `origin`, `user`,
`gender`, `stopSms`, `notary`, `relations`, `subscriptions`,
`searchRequests`, `agency`, `consent`, `mandate`, `website`.

Endpoint: GET /customers/{customerId}
Version: 1.6.0
Security: bearerAuth

## Security:

  - `bearerAuth` (unknown)
    http bearer opaque

## Path parameters:

  - `customerId` (integer, required)
    Unique identifier of the customer.

## Query parameters:

  - `include` (string)
    Comma-separated list of relations to include in the response.
Each include triggers additional data loading.

## Response 200:

  - `200` (unknown)
    Customer details

## Response 200 fields (application/json):

  - `data` (object)
    Customer details. Optional relations are loaded via the `?include=` parameter
and are absent from the response otherwise.
Response keys follow `snake_case`. Some camelCase keys are still returned but
deprecated (see the changelog); use their snake_case equivalents.

  - `data.id` (integer)
    Unique customer identifier.
    Example: 789

  - `data.gender` (object)
    Gender details (or the raw gender code when not loaded). Loaded with `include=gender`.

  - `data.first_name` (string | null)
    Example: Jean

  - `data.last_name` (string | null)
    Example: Dupont

  - `data.business_name` (string | null)
    Company name (for professional customers).

  - `data.firstname` (string | null)
    **Deprecated.** Use `first_name`.

  - `data.lastname` (string | null)
    **Deprecated.** Use `last_name`.

  - `data.companyName` (string | null)
    **Deprecated.** Use `business_name`.

  - `data.email` (string | null)
    Example: jean.dupont@example.com

  - `data.phones` (array)
    Phone numbers (read-only). Each entry has a stable `slot` (1-4), the
`number`, its `type` (`{id, label}`), and the `stop_sms` flag. Empty
slots are omitted.

  - `data.phones.slot` (integer)
    Phone slot (1-4).
    Example: 1

  - `data.phones.number` (string | null)
    Example: +33201010101

  - `data.phones.type` (object | null)

  - `data.phones.type.id` (integer | null)
    Phone type ID.

  - `data.phones.type.label` (string | null)
    Phone type label.

  - `data.phones.stop_sms` (boolean)
    SMS opt-out flag for this number. Loaded with `include=stopSms`.

  - `data.phone` (string | null)
    **Deprecated.** Use the `phones` array.
    Example: +33201010101

  - `data.mobilePhone` (string | null)
    **Deprecated.** Use the `phones` array.
    Example: +33601010101

  - `data.origin` (object)
    Customer acquisition origin. Loaded with `include=origin`.

  - `data.assigned_user` (any)
    Assigned negotiator. Full object when `include=user`, otherwise `{ id }`,
or `null` when no negotiator is assigned.

  - `data.assigned_user.id` (integer)
    Unique identifier of the user (agent).
    Example: 703387

  - `data.assigned_user.firstname` (string | null)
    User first name.
    Example: Shelby

  - `data.assigned_user.lastname` (string | null)
    User last name.
    Example: Austin

  - `data.assigned_user.email` (string | null)
    User email address.
    Example: s.austin@example.com

  - `data.assigned_user.phone` (string | null)
    Office phone number.
    Example: 0201020300

  - `data.assigned_user.mobile_phone` (string | null)
    Mobile phone number.
    Example: 0682132643

  - `data.assigned_user.picture` (string | null)
    Absolute URL of the user picture.
    Example: https://.../members/703387.jpg

  - `data.assigned_user.status` (integer | null)
    User status:
- `1`
 — Active
- `0`
 — Archived
    Example: 1

  - `data.assigned_user.agency_id` (integer | null)
    Primary agency ID the user belongs to.
    Example: 263961

  - `data.created_by` (any)
    Creator of the customer. `{ id }` or full object with `include=user`, `null` if none.

  - `data.agency` (object | null)
    Customer agency. Returned as `{ id }` by default, as a full object when
`include=agency` is requested, or `null` when none.

  - `data.next_contact_at` (string | null)
    Date of the next planned contact.

  - `data.reference` (string | null)
    Internal reference of the customer.

  - `data.created_via` (object | null)
    Technical creation channel (`{id, label}`).

  - `data.informations` (object)
    **Deprecated.** Use `created_via`.

  - `data.comments` (string | null)
    Free-text comments about the customer.

  - `data.current_situation` (object | null)
    Current situation of the customer (`{id, label}`).

  - `data.type` (integer | null)
    **Deprecated.** Use `current_situation`.

  - `data.groups` (array)
    Customer groups. Loaded with `include=groups`.

  - `data.groups.id` (integer)
    Group ID.
    Example: 1

  - `data.groups.name` (string)
    Group display name.
    Example: Demandeur

  - `data.address` (array)
    Customer addresses. Loaded with `include=address`.

  - `data.color` (object)
    Customer color (`id`, `value`, `letter`, `label`). Loaded with `include=color`.

  - `data.newsletter` (boolean | null)
    Newsletter subscription flag.

  - `data.subscriptions` (array)
    Alert subscriptions. Loaded with `include=subscriptions`.

  - `data.rgpd_consent` (boolean)
    GDPR consent flag (customers.rgpd column).

  - `data.rgpd` (boolean)
    GDPR consent data. Loaded with include=rgpd.

  - `data.consent` (object)
    Active cold-calling consent for the customer.

  - `data.consent.reason` (string)
    Reason/motive for the consent.
    Example: Accord verbal lors de la visite

  - `data.consent.accept_outside_hours` (boolean)
    Whether the customer accepts being contacted outside business hours.
    Example: true

  - `data.consent.consent_date` (string | null)
    Date when consent was given.
    Example: 2026-06-15T10:00:00+02:00

  - `data.consent.proofs` (array)
    Proof files stored in cloud storage (ImmoCloud).

  - `data.consent.proofs.folder` (string)
    Cloud storage folder path.
    Example: Private/Consentement

  - `data.consent.proofs.file` (string)
    Filename in cloud storage.
    Example: formulaire-signe-668a3f2e1b4c7.pdf

  - `data.created_at` (string | null)
    Example: 2025-01-15T10:30:00+01:00

  - `data.updated_at` (string | null)

  - `data.createdAt` (string | null)
    **Deprecated.** Use `created_at`.

  - `data.updatedAt` (string | null)
    **Deprecated.** Use `updated_at`.

  - `data.notary` (object | null)
    Notary customer. Returned as `{ id }` by default, as a full customer object when
`include=notary` is requested, or `null` when none.

  - `data.mandate` (array)
    Registered mandates. Loaded with `include=mandate`.

  - `data.website` (object)
    Client area access (`is_access_granted`, `url`, `last_login_at`,
`login_count`, `account_created_at`, `account_updated_at`). Loaded with `include=website`.

  - `data.search_requests` (array)
    Search requests. Loaded with `include=searchRequests`.

  - `data.search_requests.id` (integer)

  - `data.search_requests.name` (string | null)

  - `data.search_requests.comment` (string | null)

  - `data.search_requests.is_active` (boolean)

  - `data.search_requests.has_email_alert` (boolean)

  - `data.search_requests.has_sms_alert` (boolean)

  - `data.search_requests.intended_use` (object | null)
    Intended use (`{id, label}`).

  - `data.search_requests.reason_for_purchase` (object | null)
    Reason for purchase (`{id, label}`).

  - `data.search_requests.current_resale` (object | null)
    Current resale (`{id, label}`).

  - `data.search_requests.timeframe` (object | null)
    Timeframe (`{id, label}`).

  - `data.search_requests.created_at` (string | null)

  - `data.search_requests.updated_at` (string | null)

  - `data.search_requests.criteria` (array)
    Search criteria (internal `COMPRIS` bounding rows excluded).

  - `data.search_requests.criteria.id` (integer | null)
    Criteria ID.

  - `data.search_requests.criteria.operator` (string | null)
    Comparison operator (e.g. EGAL, SUPERIEUR, CONTIENT).

  - `data.search_requests.criteria.value` (any)
    Value(s). A string, or an array of strings for multi-value criteria.

  - `data.search_requests.key_points` (object)
    Key points split into pros and cons.

  - `data.search_requests.key_points.pros` (array)

  - `data.search_requests.key_points.cons` (array)

  - `data.search_requests.polygons` (array)

  - `data.search_requests.polygons.type` (string | null)
    Search type (time | distance | free).

  - `data.search_requests.polygons.mode` (string | null)
    Travel mode.

  - `data.search_requests.polygons.start` (string | null)
    Starting point.

  - `data.search_requests.polygons.value` (integer | null)
    Value in km or minutes.

  - `data.search_requests.polygons.polygon` (any)
    Polygon coordinates.

  - `data.search_requests.isActive` (boolean)
    **Deprecated.** Use `is_active`.

  - `data.search_requests.hasEmailAlert` (boolean)
    **Deprecated.** Use `has_email_alert`.

  - `data.search_requests.hasSmsAlert` (boolean)
    **Deprecated.** Use `has_sms_alert`.

  - `data.search_requests.createdAt` (string | null)
    **Deprecated.** Use `created_at`.

  - `data.search_requests.updatedAt` (string | null)
    **Deprecated.** Use `updated_at`.

  - `data.relations` (array)
    Related customers. Loaded with `include=relations`.

  - `data.relations.id` (integer)
    ID of the related customer.
    Example: 123456789

  - `data.relations.first_name` (string | null)
    Example: Marie

  - `data.relations.last_name` (string | null)
    Example: Dupont

  - `data.relations.business_name` (string | null)
    Company name of the related customer (for professional customer).

  - `data.relations.role` (object)
    Role of the related customer within the relationship.

  - `data.relations.role.id` (integer)
    Role list value ID (liste 17).
    Example: 29

  - `data.relations.role.label` (string)
    Example: Épouse

  - `data.relations.keep_informed` (boolean)
    Whether this related customer should be kept informed.
    Example: true

  - `data.relations.is_joint_ownership` (boolean)
    Whether the relationship is a joint ownership (indivision).
    Example: false

  - `data.relations.joint_ownership` (object | null)
    Joint ownership details, or `null` when the relationship is not a
joint ownership.

  - `data.relations.joint_ownership.share_percent` (string | null)
    Ownership share (percentage).
    Example: 50

  - `data.typeProject` (object)
    **Deprecated.** Moved to the search request level (`intended_use`).

  - `data.stopSms` (object)
    **Deprecated.** Use the `phones` array with `include=stopSms`.

  - `data.searchRequests` (array)
    **Deprecated.** Use `search_requests`.

## Response 403:

  - `403` (unknown)
    Access denied. The error `code` is always `FORBIDDEN`; the `message` gives the cause:
- `You do not have permission to perform this action.`
 — the access does not

hold the API pack / right required by the endpoint.
- `Insufficient scope for this request.`
 — the resource targeted by the request

(user, customer, product, agency, transaction, ...) is outside the scope of

the authenticated access.
- `Access denied for this editor.`
 /
`Your IP address has been blocked.`
 —

editor or IP restriction.

## Response 403 fields (application/json):

  - `error` (object)

  - `error.code` (string, required)

  - `error.message` (string, required)

## Response 403 examples:

  - `Missing API pack / right` (unknown)

  - `Resource outside the scope of the access` (unknown)

