---
title: "GetSubProperties"
method: POST
path: "/GetSubProperties"
tags: ["Connection"]
---

# GetSubProperties

`POST /GetSubProperties`

Some OTAs only tie one property to a specific login username/password where
the username is also the ota_property_id. Others allow for one
username/password to be associated with multiple properties. In this second
case, each OTA property identifier is stored as an `ota_property_sub_id` in
order to be handled separately from the property's OTA username. This method
call should return all of the properties (ota_property_sub_ids) associated
with the OTA's username/password so that the correct `ota_property_sub_id`
can be linked with our `mya_property_id` for a specific property.

*IMPORTANT*: Please contact us to enable this feature for your OTA. It is
NOT enabled by default. It is only necessary if your OTA allows for
multiple properties associated with one login username/password.

Implementation suggestions: `ota_property_sub_id` will be the OTA identifier
for a specific property managed by the hotel while the title is that
property's name. This method will allow the property to map their
Cloudbeds property with the OTA's `ota_property_sub_id` when setting up
the property-OTA association on Cloudbeds.

## Request body

- object
  - `mya_property_id` integer — Property ID on the Cloudbeds channel manager
  - `ota_property_id` string — Username, login or property ID on the OTA
  - `ota_property_password` string — Password for property on your OTA. In case the OTA does not use passwords this will be an empty string.
  - `ota_property_sub_id` '' — Always an empty string for this call
  - `guid` string — Request reference ID, used for debugging and support requests.
  - `shared_secret` string — Authentication between the OTA and the channel. Identical for all requests. Not to be shared with customers.
  - `ota_cid` string — OTA ID as given by Cloudbeds
  - `verb` 'GetSubProperties', required

## Response `200`

GetSubProperties

- union
  - object
    - `success` true, required
    - `SubProperties` object[], required — List of properties for the user on the OTA.
      - `ota_property_sub_id` string, required — Property ID on the OTA.
      - `title` string, required — Name of the property
  - ResponseError
    - `errors` object[], required — Array of error objects.
      - `id` integer, required — Error code. Check the "Error Codes" section of the specification for valid codes.
      - `msg` string — Optional error string to give more details about the error. Myallocator localises errors into different langauges, so this field is generally ignored and only useful for debugging.
    - `success` false, required

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/versions/2faa857793e8/schema)