List Projects

GEThttps://api.confident-ai.com/v2/organization/governance-policies/{policyId}/projects

Lists the projects enrolled in a governance policy one page at a time, newest created project first, as ids and names only. totalGovernancePolicyProjects counts every enrolled project, not just the current page. Retrieve the policy by id for each project's verdict per control, or a project's own governance view for its verdict history.

GET/v2/organization/governance-policies/{policyId}/projects

curl -X GET "https://api.confident-ai.com/v2/organization/governance-policies/{policyId}/projects" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"

200

{
  "success": true,
  "data": {
    "projects": [
      {
        "id": "<PROJECT-ID>",
        "name": "Customer Support Agent"
      }
    ],
    "totalGovernancePolicyProjects": 4,
    "page": 1,
    "pageSize": 25
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

policyIdstringRequired
The id of the governance policy.

Query parameters

pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of projects per page, at most 100. Defaults to 25.

Response

List Projects succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of the projects enrolled in a governance policy, with the total across all pages.
Show 4 propertiesHide 4 properties
- projectslist of objects
  The projects enrolled in this policy for the current page, newest created project first.
  Show 2 propertiesHide 2 properties
  - idstring
    The id of the project.
  - namestring
    The name of the project.
- totalGovernancePolicyProjectsinteger
  How many projects are enrolled in this policy across every page.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of projects per page.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI