Skip to content

List event types

Request

Returns the agency configured event types with their display form (visible and collapsed fields). Cursor-based pagination. Requires the MODULE_IMMO_AGENDA module and SITE_CALENDAR:READ permission.

Security
bearerAuth
Query
perPageinteger, <= 50

Maximum number of event types to return per page. Values above 50 are capped to 50.

Default:50
cursorstring

Opaque pagination cursor. Pass the meta.next_cursor value returned by the previous response to fetch the next page. Omit for the first page.

curl -i -X GET \
  'https://api-doc.immo-facile.com/_mock/openapi/calendar/events/types?perPage=50&cursor=string' \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>'

Responses

List of event types

Bodyapplication/json
dataArray of objects(EventTypeResponse)
metaobject(CursorPaginationMeta-4)

Pagination metadata for cursor-based listings.

Response
{
  "data": [
    { … }
  ],
  "meta": {
    "per_page": 50,
    "next_cursor": "eyJpZCI6MTIzfQ==",
    "prev_cursor": "string"
  },
  "links": {
    "next": "string",
    "prev": "string"
  }
}