List reporting groups

get

https://{hostname}/cprg/v1/reporting-groups

Lists detailed information about reporting groups available for your account and contract.

Query Params

contractId

string

Identifies the contract to filter data by. Include this optional parameter to narrow down the results to a specific contract only.

groupId

string

Identifies the access group to filter data by. Include this optional parameter to narrow down the results to a specific access group only.

reportingGroupName

string

The name of the reporting group to filter data by. Include this optional parameter to narrow down the results to a specific reporting group name only.

cpcodeId

string

Identifies the CP code to filter data by. Include this optional parameter to narrow down the results to a specific CP code only.

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

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

200Lists details of reporting groups available for a specified account and contract.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.