Skip to content

List users
Websites

Request

Returns all users (agents/collaborators) for the authenticated site, with optional filters and cursor-based pagination. Requires SITE_ADMIN:READ permission and RS:ADMIN_ALL right.

Filters: All query parameters are optional. Combine them to narrow results.

Pagination: Uses cursor-based pagination. Pass meta.next_cursor from the previous response as the cursor parameter to fetch the next page.

Security
bearerAuth
Query
firstnamestring

Filter by first name (partial match).

Example:firstname=Jean
lastnamestring

Filter by last name (partial match).

Example:lastname=Dupont
emailstring

Filter by email (partial match).

Example:email=dupont@example.com
statusinteger

Filter by user status:

  • 1 — Active
  • 0 — Archived
  • 3 — Hidden/deleted
Example:status=1
without_deletedboolean

When true, excludes deleted/archived users from results. Equivalent to filtering out status 0 and 3.

Example:without_deleted=true
delegationboolean

Filter by delegation flag (users who can delegate their work).

agency_idsArray of integers

Filter by agency IDs. Only returns users attached to these agencies. Each ID must be within the authenticated site's scope.

Example:agency_ids=123&agency_ids=456
per_pageinteger, <= 200

Number of results per page. Maximum 200.

Default:50
Example:per_page=50
telephone_codeboolean

When true, phone numbers are formatted in international format (e.g. +33601020304 instead of 0601020304).

Example:telephone_code=true
curl -i -X GET \
  'https://api-doc.immo-facile.com/_mock/openapi/users?firstname=Jean&lastname=Dupont&email=dupont%40example.com&status=1&without_deleted=true&delegation=true&agency_ids=123%2C456&per_page=50&telephone_code=true' \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>'

Responses

Paginated list of users

Bodyapplication/json
dataArray of objects(UserResponse)
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"
  }
}