Get user availability

Request

Returns the available slots of a user over a period, computed from their working time and existing events. Defaults to the current week when from/to are omitted. Requires SITE_CALENDAR:READ.

Security

bearerAuth

Path

userIdintegerrequired

ID of the user (agent/collaborator) whose availability is computed.

Query

tzstring

IANA timezone used to format the start/end datetimes of the returned slots. 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, 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, 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

slot_durationinteger

Desired duration of each returned availability slot, in minutes. When omitted, a default slot granularity is used.

Example:slot_duration=30

exclude_typesArray of strings

Event type keys to ignore when computing availability. Events of these types do not make the corresponding slots unavailable.

Example:exclude_types=FREE

curl -i -X GET \
  'https://api-doc.immo-facile.com/_mock/openapi/calendar/users/{userId}/availability?tz=Europe%2FParis&from=2026-01-01T00%3A00%3A00&to=2026-01-07T23%3A59%3A59&slot_duration=30&exclude_types=FREE' \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>'

Responses

List of available slots

Bodyapplication/json

dataArray of objects(AvailabilitySlot)

Response

{
  "data": [
    { … }
  ]
}