Get a reporting group

Get detailed information about a specific reporting group. The details include the reporting group name and the access control group that it belongs to. This operations also lists the contracts and CP codes assigned to the reporting group.

Recipes
List details of a reporting group
Open Recipe
Path Params
integer
required

The identifier for the reporting group.

Query Params
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.

Responses

Response body
object
accessGroup
object
required

A group that controls access to specific CP codes.

string
required
length ≥ 1

Identifies the contract assigned to the access control group. Get and store this ID from your account using the Contracts API.

Note: See ID prefixes for guidance on comparing this value with data from PAPI.

integer | null
required
≥ 0

Identifies the access control group. Reporting groups may belong to many groups. If that happens, this member's value is null.

Note: See ID prefixes for guidance on comparing this value with data from PAPI.

contracts
array of objects
required
length ≥ 0

A collection of contracts and CP codes assigned to the reporting group.

contracts*
object
string
required
length ≥ 1

Identifies the contract assigned to the reporting group.

Note: See ID prefixes for guidance on comparing this value with data from PAPI.

cpcodes
array of objects
required
length ≥ 0

A collection of CP codes assigned to the reporting group.

cpcodes*
object
integer
required
≥ 0

Identifies a CP code.

Note: See ID prefixes for guidance on comparing this value with data from PAPI.

string
length ≥ 1

The descriptive label for the CP code.

integer
required
≥ 0

Identifies the reporting group.

string
required
length ≥ 1

The descriptive label for the reporting group.

Language
Authentication
URL