Skip to content

Search events

Request

Searches events over a period with optional filters. Defaults to the current day when from/to are omitted. Recurring events are expanded by default. Requires SITE_CALENDAR:READ.

Security
bearerAuth
Query
user_idinteger

Restricts event visibility to this user's perspective. Affects which confidential/private events are returned.

user_idsArray of integers

Restricts the result to events involving these user (agent) IDs as participants.

agency_idsArray of integers

Restricts the result to events belonging to these agency IDs. Each ID must be among the agencies the authenticated client can read, otherwise a 403 is returned.

tzstring

IANA timezone applied to the returned event datetimes. 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 search window (local datetime, format YYYY-MM-DDTHH:MM:SS). Defaults to the start of the current day (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 search window (local datetime, format YYYY-MM-DDTHH:MM:SS). Defaults to the end of the current day (23:59 UTC) when omitted.

Example:to=2026-01-31T23:59:59
perPageinteger, <= 50

Maximum number of events to return. Values above 50 are capped to 50.

Default:50
offsetinteger

Number of events to skip from the start of the result set (offset pagination).

Default:0
excluded_typesArray of strings

Event type ids to exclude from the result (e.g. to hide working-time or free slots from a calendar view).

Example:excluded_types=1&excluded_types=2
recurringboolean

When true (default), recurring events are expanded into their individual occurrences within the search window. When false, only the master event is returned.

Default:true
archivedboolean

When false (default), archived events are excluded. Set to true to include archived events in the result.

Default:false
curl -i -X GET \
  'https://api-doc.immo-facile.com/_mock/openapi/calendar/events?user_id=0&user_ids=0&agency_ids=0&tz=Europe%2FParis&from=2026-01-01T00%3A00%3A00&to=2026-01-31T23%3A59%3A59&perPage=50&offset=0&excluded_types=1%2C2&recurring=true&archived=false' \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>'

Responses

List of events

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