Calendar

Retrieve A Calendar Item

get/v1/calendar-item/{calendar_id}

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/calendar-item/{calendar_id}
  • Auth: API key in header X-Imobzi-Secret

Path parameters

calendar_idstring required

Query parameters

cursor_fwstring nullable
cursor_rwstring nullable
item_typeunknown
user_idstring nullable
yearstring nullable
initial_datestring nullable
final_datestring nullable
monthinteger nullable
daystring nullable
weekstring nullable
calendar_typeunknown
scheduleboolean nullable
holiday_yearstring nullable
lease_statusunknown
team_idstring nullable
search_allboolean nullable

Response

Successful Response

all_dayboolean nullable

Indicates if the event lasts the whole day. Optional.

descriptionstring nullable

Description of the item or event. Optional.

doneboolean nullable

Marks the item as completed. Optional.

google_calendar_event_idstring nullable

Google Calendar event ID. Used for syncing. Optional.

initial_datestring nullable

Start date and time in ISO format. Must include +3 hours offset (UTC+3). Required when creating the item.

final_datestring nullable

End date and time in ISO format. Must include +3 hours offset (UTC+3). Required when creating the item.

notificationstring nullable

Text or configuration for a notification. Optional.

titlestring nullable

Title or name of the item. Optional but recommended.

typestring nullable

Item subtype (e.g. 'open_house', 'custom_type'). Optional.

contact_typeunknown
notification_bystring[]

Channels to send notification (e.g. ['email', 'push']). Optional.

send_bystring[] nullable

Channels used to send this calendar item automatically.

show_observationsboolean nullable

If true, show internal notes or observations. Optional.

recurring_idstring nullable

ID of the recurring item (if part of a series). Optional.

group_recurring_idstring nullable

ID for the group of recurring items. Optional.

original_recurring_idstring nullable

Original ID from which this recurring item was created. Optional.

statusstring nullable

Status of the item (e.g. 'confirmed', 'canceled'). Optional.

resend_notificationboolean nullable

If true, forces notification to be sent again. Optional.

properties_in_databoolean nullable

Changes

No recorded changes to this operation across all 1 revision of this API.