# List users

Returns all users (agents/collaborators) for the authenticated site,
with optional filters and cursor-based pagination.
**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.

Endpoint: GET /users
Version: 1.6.0
Security: bearerAuth

## Security:

  - `bearerAuth` (unknown)
    http bearer opaque

## Query parameters:

  - `firstname` (string)
    Filter by first name (partial match).

  - `lastname` (string)
    Filter by last name (partial match).

  - `email` (string)
    Filter by email (partial match).

  - `status` (integer)
    Filter by user status:
- `1`
 — Active
- `0`
 — Archived
- `3`
 — Hidden/deleted

  - `without_deleted` (boolean)
    When true, excludes deleted/archived users from results.
Equivalent to filtering out status 0 and 3.

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

  - `agency_ids` (array)
    Filter by agency IDs. Only returns users attached to these agencies.
Each ID must be within the authenticated site's scope.

  - `per_page` (integer)
    Number of results per page. Maximum 200.

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

## Response 200:

  - `200` (unknown)
    Paginated list of users

## Response 200 fields (application/json):

  - `data` (array)

  - `data.id` (integer)
    Unique user identifier.
    Example: 582602

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

  - `data.lastname` (string | null)
    Example: Martin

  - `data.gender` (string | null)
    Gender code (m, f, s, etc.).
    Example: f

  - `data.sexe` (string | null)
    Sexe label (legacy field).

  - `data.is_rsac_displayed` (boolean | null)
    Whether the RSAC number is displayed publicly.

  - `data.ai_consent` (boolean)
    Whether the user consented to AI features.

  - `data.editor_code` (string | null)
    Network/editor code this user belongs to.

  - `data.picture` (string | null)
    Profile picture URL.

  - `data.signature` (string | null)
    Signature picture URL.

  - `data.email` (string | null)
    Example: marie.martin@agence.fr

  - `data.phone` (string | null)
    Office phone number.
    Example: +33498765432

  - `data.mobile_phone` (string | null)
    Mobile phone number.
    Example: +33698765432

  - `data.site_code` (string | null)
    Primary site code.

  - `data.rsac_number` (string | null)
    RSAC registration number (commercial agent).

  - `data.description` (string | null)
    Public bio/description.

  - `data.delegation` (boolean | null)
    Whether delegation is enabled.

  - `data.status` (integer | null)
    1=Active, 0=Archived, 3=Hidden/Deleted
    Example: 1

  - `data.rsac_city` (string | null)
    RSAC registration city.

  - `data.production_ratio` (number | null)
    Production ratio (performance metric).

  - `data.ip_filter` (string | null)
    IP address whitelist for this user.

  - `data.group_id` (integer | null)
    Primary permission group ID.
    Example: 2

  - `data.group_id2` (integer | null)
    Secondary permission group ID.

  - `data.last_login_date` (string | null)
    Last login timestamp.
    Example: 2026-06-15T08:30:00+02:00

  - `data.is_email_valid` (boolean | null)
    Whether the email has been validated.

  - `data.color` (string | null)
    Calendar color code (hex).

  - `data.experience` (string | null)
    Years of experience or experience description.

  - `data.career_path` (string | null)

  - `data.specialty` (string | null)
    Professional specialty.

  - `data.zimbra_login` (string | null)
    Zimbra email login.

  - `data.zimbra_alias` (string | null)
    Zimbra email alias.

  - `data.agency_id` (integer | null)
    Primary agency ID.
    Example: 123

  - `data.agencies_list` (string | null)
    Comma-separated list of accessible agency IDs.
    Example: 123,456

  - `data.agencies_list_affectation` (string | null)
    Comma-separated list of lead affectation agency IDs.

  - `data.is_visible_directory` (boolean)
    Whether the user is visible in the public agency directory.

  - `data.professional_liability_number` (string | null)
    Professional liability insurance number.

  - `data.professional_liability_organization` (string | null)
    Insurance organization name.

  - `data.professional_liability_address` (string | null)
    Insurance organization address.

  - `data.jestimo_login` (string | null)
    Jestimo (valuation tool) login.

  - `data.user_types` (array)
    List of user type IDs (professional roles).
    Example: [1]

  - `data.logs` (array | null)
    Recent action log entries for this user.
Loaded only when `?include=logs` is requested.

  - `data.logs.id` (integer)

  - `data.logs.name` (string | null)
    Action type label.

  - `data.logs.date_performed` (string | null)

  - `meta` (object)
    Pagination metadata for cursor-based listings.

  - `meta.per_page` (integer)
    Number of items returned per page.
    Example: 50

  - `meta.next_cursor` (string | null)
    Cursor to pass in the next request to fetch the next page.
Null when there is no next page.
    Example: eyJpZCI6MTIzfQ==

  - `meta.prev_cursor` (string | null)
    Cursor for the previous page. Null on first page.

  - `links` (object)
    Ready-to-use links for cursor-based navigation.

  - `links.next` (string | null)
    URL of the next page, or null.

  - `links.prev` (string | null)
    URL of the previous page, or null.

## 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)

