Skip to main content
GET
/
policies
List Policies
curl --request GET \
  --url https://www.corgea.app/api/v1/policies \
  --header 'CORGEA-TOKEN: <api-key>'
{
  "policies": [
    {
      "id": 123,
      "description": "<string>",
      "cwes": [
        "<string>"
      ],
      "excludes": [
        "<string>"
      ],
      "projects": [
        "<string>"
      ],
      "company": 123,
      "active": true,
      "approved": true,
      "approved_by": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "glob_pattern": "<string>",
      "source_type": "Web",
      "repo_policy_file": 123,
      "name": "<string>",
      "guidance_text": "<string>",
      "version": 123,
      "archived": true,
      "parent_policy": 123,
      "read_only": true,
      "created_by_corgea": true
    }
  ],
  "pagination": {
    "total_count": 123,
    "total_pages": 123,
    "current_page": 123,
    "page_size": 123
  }
}

Authorizations

CORGEA-TOKEN
string
header
required

API key for authentication

Query Parameters

project_id
integer

Filter to policies that apply to a project. Company-wide policies are included.

policy_type
string

Filter by one or more comma-separated policy types.

active
boolean

Filter by active status

page
integer
default:1

The page number for pagination

page_size
integer
default:20

The number of results per page

Required range: x <= 30

Response

Policies retrieved successfully

policies
object[]
pagination
object