Cloudbeds accounts (properties) can be grouped under one group account (often referred as mygroup). Group users have highest level user permissions in all of the grouped accounts (properties).
Calls that provide group account data have "Group account support" label in the API doc.
You, as integration developer, can decide if you’d like to allow group users to authorize your application for the entire group or not.
- If you do want to support group properties - A group admin user in Cloudbeds will be able to authorize your app for all of the group properties at once.
In order to support that you will have to pull the group property list with getHotels method and then use propertyID parameter for each of your following calls. (see details below)
- If you don't want to support group properties - A group admin won't be able to authorize your app for all properties in the group. Cloudbeds customer will have to log in with their property level user login and then authorize for each property separately.
Let us know before you start development and we’ll switch this option to ON for you and send you the test group property login. By default, you’ll have this option OFF.
When a group admin user authorizes the app, OAuth credentials are valid to use for all properties in the group.
Using propertyID parameter
For associations or users that have access to multiple properties, there may be an additional parameter to the ones described in each method specification. Some methods will require a specified property ID, and others can accept multiple property IDs.
This can be verified on method description, or if by omitting this parameter it will result in the error message: "Please specify "propertyID" parameter for this call".
This parameter can also be used, for these users, to filter results based on the selected property IDs.
For users who have access to a single property, this parameter is not needed.
$curl = curl_init();$curl_post_data = array( 'status' => 'checked_out', 'propertyID' => '1,2',); curl_setopt($curl, CURLOPT_HTTPHEADER, array('Authorization: Bearer '. $access_token )); curl_setopt($curl, CURLOPT_URL, "http://hotels.cloudbeds.com/api/v1.1/getGuestsByStatus"); curl_setopt($curl, CURLOPT_POSTFIELDS,$curl_post_data); curl_exec($curl); curl_close($curl);
||ID for the properties to be queried (comma-separated).