List CP codes

This operation lists CP codes available within your contract and group pairing. You assign CP codes to a property within its rule tree. To list all CP codes in your account at once, without having to filter the request by contracts and groups, use the CP Codes and Reporting Groups API. CP codes include information about their product assignment. When creating a new property, you need to apply the same product you specified for the assigned CP code.

To view or update certain CP code data, such as name, time zone, and purgeability, use the CP Codes and Reporting Groups API.

Query Params
string
required

Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix.

string
required

Unique identifier for the group. See ID prefixes for details on omitting the value's grp_ prefix.

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
string
enum
required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json