Query a Property

get

https://service.pcibooking.net/api/admin/property

This process provides the list of Properties connected to the merchant, with their property IDs.
Depending on the request, you can get all the Property information, or a minimum set of parameters.

We recommend that you first review the guide for this method.

Query Params

FullData

boolean

Defaults to false

Determine what to send in response. false: minimum data. true: maximum data.

limit

int32

Defaults to 100

Number of items returned

start

int32

Defaults to 0

The items returned will start at {start} number, zero-based

Status

string

Property status. Status can be: -1 for PendingSendInvitation, -2 for Pending user activation, 1 for Activated, -10 for Closed

Name

string

Property name. Will pull the list of Properties, starting with the string.

Created_time_from

string

required

Creation date from. Format: YYYY-MM-DDTHH:MM:SS, ISO 8601 format.

Created_time_to

string

required

Creation date to. Format: YYYY-MM-DDTHH:MM:SS, ISO 8601 format

Updated_time_from

string

Updated date from. Format: YYYY-MM-DDTHH:MM:SS, ISO 8601 format.

Updated_time_to

string

Updated date to. Format: YYYY-MM-DDTHH:MM:SS, ISO 8601 format.

Country

string

The Property's country location, taken from property information. Country code is 2 digits ISO 3166-2. See here the country list.

City

string

The Property's city. Will pull the list of Properties, with the city starting the string.

Headers

Authorization

string

required

The authorization mechanism for this method is with the API key in the format of APIKEY {value}.
For example, APIKEY bd3ce883352e42539a2b7644f72e6311.

Responses

200200

400400