Skip to content

List permanence users

Request

Returns the users assigned to permanence slots over a period for an agency. Defaults to the current week when from/to are omitted. Requires SITE_CALENDAR:READ.

Security
bearerAuth
Query
agency_idintegerrequired

Target agency ID. Must be among the agencies the authenticated client can read, otherwise a 403 is returned.

tzstring

IANA timezone used to format the start/end datetimes in the response. Defaults to UTC when omitted.

Example:tz=Europe/Paris
fromstring^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}...

Start of the period (local datetime, no timezone suffix, format YYYY-MM-DDTHH:MM:SS). Defaults to the start of the current week (Monday 00:00 UTC) when omitted.

Example:from=2026-01-01T00:00:00
tostring^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}...

End of the period (local datetime, no timezone suffix, format YYYY-MM-DDTHH:MM:SS). Defaults to the end of the current week (Sunday 23:59 UTC) when omitted.

Example:to=2026-01-07T23:59:59
curl -i -X GET \
  'https://api-doc.immo-facile.com/_mock/openapi/calendar/permanences/timeframe/users?agency_id=0&tz=Europe%2FParis&from=2026-01-01T00%3A00%3A00&to=2026-01-07T23%3A59%3A59' \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>'

Responses

List of permanence users

Bodyapplication/json
dataArray of objects(PermanenceUserResponse)
Response
{
  "data": [
    { … }
  ]
}