API Documentation

Retrieve units

get
https://api.ciiruspartners.com/v2023.07.31/inventory

This method will retrieve all the units available to the API user.

Query Params
int32
≥ 1
Defaults to 1

The page to be shown.

int32
1 to 1000
Defaults to 25

Limits the number of returned results.

date-time

Only return objects which have been modified after a certain date.

int32
≥ 0

Unique Identifier for supplier.

mcUserIds
array of int32s

Unique Identifiers for suppliers.

mcUserIds
int32
≥ 0

Unique Identifier for inventory.

unitIds
array of int32s

Unique Identifiers for inventory.

unitIds
boolean

Sets the 'enabled' status of units. Overriden by body on multi-endpoint.

boolean

Return additional context information.

boolean

Return additional context information relating to airbnb.

boolean

Only show properties which are enabled for website.

boolean

Only show properties which allocation on arrival.

integer

Only show properties which belong to a given community.

boolean

Only show properties which are deleted or not deleted.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 8 months 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 8 months ago