API Documentation

Retrieve units calendars

get
https://api.ciiruspartners.com/v2024.07.31/unit_calendars
Query Params
int32
≥ 1
Defaults to 1

The page to be shown.

int32
≥ 1
Defaults to 25

Limits the number of returned results.

date-time

Only return units which have been modified after the specified date.

date-time

Only return units which have received a booking (their own or a calendar sync) after the specified date.

date-time

Only return units which have had their agent module property configuration modified after the specified date.

date-time

Only return units which have had their agent module agent configuration modified after the specified date.

int32
≥ 0

Identifier for unit.

unit_ids
array of int32s

Identifiers for units.

unit_ids
int32
≥ 0

Identifier for supplier.

management_company_user_ids
array of int32s

Identifiers for suppliers.

management_company_user_ids
boolean

Use only enabled or disabled units.

boolean

Only show properties which are deleted or not deleted.

boolean

Only show properties which are enabled for website.

boolean

Return the allocation on arrival object.

boolean

Return units which are the representative unit in their group.

string
enum

Fallback method. Defaults to 'fallback_max_value_rate_plus_guards'.

Allowed:
date
required

Beginning date for payments to return.

date
required

End date for payments to return.

int32
≥ 0

Unique Identifier for booking.

allocated_reservations
array of int32s

Unallocated reservations that you would like to virtually allocate.

allocated_reservations
int32

Booking category to ignore.

string
enum

Specify channel.

Allowed:
string

Listing id to lookup.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 12 days ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 12 days ago