Skip to content

Search customers
Customers

Request

Searches customers with cursor-based pagination. Requires SITE_CUSTOMER:READ permission and RS:CUSTOMER_SEARCH right.

Results are ordered by customers_id descending (most recent first).

Security
bearerAuth
Bodyapplication/jsonrequired
first_namestring or null

Filter by first name (partial match).

Example:"Jean"
last_namestring or null

Filter by last name (partial match).

Example:"Dupont"
emailstring or null

Filter by email (exact match).

Example:"jean.dupont@example.com"
phonestring or null

Filter by phone number (partial match).

Example:"0601010101"
agency_idinteger or null

Filter by agency ID.

Example:263961
group_idinteger or null

Filter by customer group ID.

Example:1
origin_idinteger or null

Filter by customer origin ID.

Example:12
per_pageinteger, [ 1 .. 200 ]

Number of results per page. Maximum 200.

Default:50
Example:25
cursorstring or null

Opaque pagination cursor from the previous response's meta.next_cursor. Omit for the first page.

firstnamestring or nulldeprecated

Deprecated. Use first_name.

lastnamestring or nulldeprecated

Deprecated. Use last_name.

curl -i -X POST \
  https://api-doc.immo-facile.com/_mock/openapi/customers/search \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "dupont@example.com",
    "per_page": 25
  }'

Responses

Paginated search results

Bodyapplication/json
dataArray of objects(CustomerResponse)
metaobject(CursorPaginationMeta-2)

Pagination metadata for cursor-based listings.

Response
{
  "data": [
    { … }
  ],
  "meta": {
    "per_page": 50,
    "next_cursor": "eyJpZCI6MTIzfQ==",
    "prev_cursor": "string"
  },
  "links": {
    "next": "string",
    "prev": "string"
  }
}