---
title: "List Policy Group Check results"
method: GET
path: "/policy-group-checks/{policy_group_check}/policy-check-results"
tags: ["policy-group-checks"]
---

# List Policy Group Check results

`GET /policy-group-checks/{policy_group_check}/policy-check-results`

## Request

- Base URL: `https://example.scalr.io/api/iacp/v3`
- URL: `https://example.scalr.io/api/iacp/v3/policy-group-checks/{policy_group_check}/policy-check-results`
- Auth: HTTP bearer

List policy check results for a specific policy group check.

Required permission: policy_groups:read

## Path parameters

- `policy_group_check` string, required

## Query parameters

- `query` string
- `filter[policy]` string
- `filter[date]` string
- `filter[result]` string
- `filter[environment]` string
- `filter[workspace]` string
- `filter[terragrunt-unit]` string
- `format` string
- `include` string[]
- `fields` object
  - `environments` string: The comma-separated list of fields to return in response for Environment resource.
  - `policy-check-results` string: The comma-separated list of fields to return in response for PolicyCheckResult resource.
  - `workspaces` string: The comma-separated list of fields to return in response for Workspace resource.
- `page[number]` string
- `page[size]` string
- `sort` string[]

## Response `200`

Success.

- PolicyCheckResultListingDocument: JSON:API Document Listing see: https://jsonapi.org/format/#document-structure
  - `data` PolicyCheckResult[]
    - `attributes` object
      - `messages` string[]: The messages returned by the policy check.
      - `name` string: The name of the policy.
      - `pull-request-number` string, nullable: The number of the pull request that triggered the policy check.
      - `pull-request-title` string, nullable: The title of the pull request that triggered the policy check.
      - `result` 'passed' | 'hard_failed' | 'soft_failed' | 'advisory_failed': The result of the policy check.
      - `unit-path` string, nullable: The terragrunt unit path relative to the working directory.
    - `id` string
    - `links` object
    - `relationships` object
      - `environment` object: The environment associated with this policy check result.
        - `data` object, nullable, required
          - `id` string, required
          - `type` 'environments' | '', required
      - `policy-check` object: The policy check this result belongs to.
        - `data` object, nullable, required
          - `id` string, required
          - `type` 'policy-checks' | '', required
      - `run` object: The run associated with this policy check result.
        - `data` object, nullable, required
          - `id` string, required
          - `type` 'runs' | '', required
      - `workspace` object: The workspace associated with this policy check result.
        - `data` object, nullable, required
          - `id` string, required
          - `type` 'workspaces' | '', required
    - `type` 'policy-check-results', required
  - `included` object[]
  - `links` object
  - `meta` object

## Other responses

- `403`: User unauthorized to perform this action.
- `404`: Policy group check not found.
- `4XX`: Client error.
- `5XX`: Server error.

---

[API](https://skmtc.dev/scalr/apis/scalr-iacp-api.md) - [All operations](https://skmtc.dev/scalr/apis/scalr-iacp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scalr/apis/scalr-iacp-api/revisions/d3e1dc85657a?raw)