Get the latest property version

get https://{hostname}/papi/v1/properties/{propertyId}/versions/latest

This operation provides either the latest property version overall, or the latest one active on the production or staging networks. By default, the response yields the property version with the highest number. Specifying an activatedOn of STAGING or PRODUCTION yields the version that's currently active on either network.

Recipes

Open Recipe

Path Params

propertyId

string

required

Unique identifier for the property. See ID prefixes for details on omitting the value's prp_ prefix.

Query Params

activatedOn

string

Enum If present, returns the latest version activated on the given network, either STAGING or PRODUCTION.

contractId

string

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

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

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

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.

Responses

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/papi/v1/properties/propertyId/versions/latest \
# Add Authorization header to this snippet
3
     --header 'PAPI-Use-Prefixes: true' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

302The response provides a redirect URL link to the latest version of the requested property.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.