List parent properties
GET https://{{host}}/papi/v1/includes/:includeId/parents
Limited availability Lists all active properties that reference a specific include. Combine optional query parameters to paginate, sort, and filter the results. Specify any includeId you get from a list of includes.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
offset | string | (Optional) For paginated responses, specifies the page of results you want to navigate to, starting from 0. | |
limit | string | (Optional) For paginated responses, specifies the number of hostnames objects to include on each page. | |
contractId | string | (Optional) Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the groupId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's ctr_ prefix. | |
groupId | string | (Optional) Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the contractId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's grp_ prefix. | |
accountSwitchKey | string | (Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
PAPI-Use-Prefixes | string | (Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs. | |
Accept | string |
RESPONSES
status: OK
{"properties":{"items":[{"accountId":"act_A-CCT9012","assetId":"aid_101","contractId":"ctr_C-0N7RAC7","groupId":"grp_54321","latestVersion":2,"productionVersion":null,"propertyId":"prp_175780","propertyName":"example.com","stagingVersion":1},{"accountId":"act_A-CCT9012","assetId":"aid_101","contractId":"ctr_K-0N7RAK7","groupId":"grp_12345","latestVersion":1,"productionVersion":null,"propertyId":"prp_175781","propertyName":"m.example.com","stagingVersion":null}]}}