Get an include
GET https://{{host}}/papi/v1/includes/:includeId
Limited availability This operation gets a specific include. You can call this operation by specifying any of the includeId members from a list of includes, or by running a GET on the includeLink response when creating a new include.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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 |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"includes":{"items":[{"accountId":"act_A-CCT5678","assetId":"aid_101","contractId":"ctr_K-0N7RAK7","groupId":"grp_12345","includeId":"inc_243237","includeName":"my.new.include.com","includeType":"COMMON_SETTINGS","latestVersion":2,"productionVersion":null,"propertyType":"INCLUDE","stagingVersion":1}]}}