Skip to content

Get a customer
Customers
Properties

Request

Returns detailed customer information. Requires SITE_CUSTOMER:READ permission and RS:CUSTOMER_GET right.

Use include to load additional relations.

Available includes: address, groups, color, origin, user, gender, stopSms, notary, relations, subscriptions, searchRequests, agency, consent, mandate, website.

Security
bearerAuth
Path
customerIdintegerrequired

Unique identifier of the customer.

Example:789
Query
includestring

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

Example:include=address,groups,origin,user
curl -i -X GET \
  'https://api-doc.immo-facile.com/_mock/openapi/customers/789?include=address%2Cgroups%2Corigin%2Cuser' \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>'

Responses

Customer details

Bodyapplication/json
dataobject(CustomerResponse)

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.

Response
{
  "data": {
    "id": 789,
    "gender": {},
    "first_name": "Jean",
    "last_name": "Dupont",
    "business_name": "string",
    "firstname": "string",
    "lastname": "string",
    "companyName": "string",
    "email": "jean.dupont@example.com",
    "phones": [ … ],
    "phone": "+33201010101",
    "mobilePhone": "+33601010101",
    "origin": {},
    "assigned_user": {},
    "created_by": {},
    "agency": {},
    "next_contact_at": "2019-08-24T14:15:22Z",
    "reference": "string",
    "created_via": {},
    "informations": {},
    "comments": "string",
    "current_situation": {},
    "type": 0,
    "groups": [ … ],
    "address": [ … ],
    "color": {},
    "newsletter": true,
    "subscriptions": [ … ],
    "rgpd_consent": true,
    "rgpd": true,
    "consent": { … },
    "created_at": "2025-01-15T10:30:00+01:00",
    "updated_at": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "notary": {},
    "mandate": [ … ],
    "website": {},
    "search_requests": [ … ],
    "relations": [ … ],
    "typeProject": {},
    "stopSms": {},
    "searchRequests": [ … ]
  }
}