List properties
GET https://{{host}}/papi/v1/properties?contractId={{contractId}}&groupId={{groupId}}
This operation lists properties available for the current contract and group. Use optional query parameters to only show properties that were modified within a specified time range or on a selected network. If you specify the modifiedSince parameter, contractId and groupId become optional. If you don't identify a contract and group, the operation lists all properties you have access to, modified within a specified time range.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
modifiedSince | string | (Optional) Filters properties or includes to those modified within a span of time. Use ISO 8601 duration values, with a limit of 30 days expressed as P30D. Values allow additional detail, such as P10DT12H15M for 10 days, 12 hours, and 15 minutes. | |
modifiedNetwork | string | (Optional) Enum Filters and only shows properties or includes that have been modified within a specified period on a selected network, either STAGING, PRODUCTION, or BOTH. You need to specify it along with the modifiedSince query parameter. | |
contractId | string | (Required) Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix. | |
groupId | string | (Required) Unique identifier for the group. 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}]}}