Launch Week 02 wrapped — explore all five launches

List Projects

GEThttps://api.confident-ai.com/v2/organization/governance-projects

Lists every project in your organization with its governance standing, ordered by project name, alongside an organization-wide roll-up of how many projects fall into each status. Projects enrolled in no governance policy are included, with a status of not_enrolled and a null health, since the inventory is what tells you which projects are ungoverned. Filter with status to narrow the list; totalGovernanceProjects then counts the projects that match the filter, while governanceProjectPortfolio keeps covering the whole organization so the roll-up does not move as you page or filter.

GET/v2/organization/governance-projects
curl -X GET "https://api.confident-ai.com/v2/organization/governance-projects" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"
200
{
  "success": true,
  "data": {
    "governanceProjects": [
      {
        "id": "<PROJECT-ID>",
        "name": "Customer Support Agent",
        "description": "Front-line support assistant for billing questions.",
        "owner": {
          "id": "<USER-ID>",
          "email": "jane@acme.com",
          "name": "Jane Doe",
          "image": null
        },
        "governancePolicy": {
          "id": "<GOVERNANCE-POLICY-ID>",
          "name": "EU AI Act readiness"
        },
        "controlsCount": 6,
        "status": "healthy",
        "health": {
          "checksTotal": 6,
          "checksRun": 5,
          "checksFailing": 1,
          "streakDays": 12,
          "lastAssessedAt": "2025-01-15T02:00:00.000Z"
        }
      }
    ],
    "totalGovernanceProjects": 12,
    "governanceProjectPortfolio": {
      "total": 12,
      "healthy": 7,
      "needsAttention": 2,
      "critical": 1,
      "awaiting": 1,
      "notEnrolled": 1,
      "aggregatePassRate": 92
    },
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/organization/<ORGANIZATION-ID>/governance/inventory",
  "deprecated": false
}

Headers

  • CONFIDENT_API_KEYstringRequired

    The organization API key for your Confident AI organization.

Query parameters

  • statusenum

    Only return projects with this status. The governanceProjectPortfolio roll-up always covers the whole organization and is not narrowed by this filter.

  • 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 governance inventory, with the organization-wide roll-up alongside it.

    Show 5 propertiesHide 5 properties
    • governanceProjectslist of objects

      The projects for the current page, ordered by project name, with their governance standing.

      Show 8 propertiesHide 8 properties
      • idstring

        The id of the project.

      • namestring

        The name of the project.

      • descriptionstring | null

        What the project is for, or null when it has no description.

      • ownerobject | null

        A Confident AI user, as referenced by the records they created.

        Show 4 propertiesHide 4 properties
        • idstring

          This is the id of the user.

        • emailstring

          This is the email address of the user.

        • namestring | null

          This is the display name of the user, or null when they have not set one.

        • imagestring | null

          This is the URL of the user's avatar, or null when they have none.

      • governancePolicyobject | null

        A governance policy, named by id.

        Show 2 propertiesHide 2 properties
        • idstring

          The id of the governance policy.

        • namestring

          The name of the governance policy.

      • controlsCountinteger

        How many controls apply to this project through the policy it is enrolled in, counting the ones that policy inherits. 0 for a project enrolled in no policy.

      • statusenum

        Where a project stands under governance. not_enrolled means it belongs to no governance policy and so has nothing to assess; awaiting means it is enrolled but no control has produced a verdict yet; healthy means no control is failing. needs_attention and critical both have failing controls and differ only by pass rate, with critical below Confident AI's healthy threshold.

        Show 5 enum valuesHide 5 enum values
        • healthy
        • needs_attention
        • critical
        • awaiting
        • not_enrolled
      • healthobject | null

        The check counts behind a project's governance status. checksRun is the denominator of its pass rate, so a project with controls that have never run reports a checksTotal above its checksRun.

        Show 5 propertiesHide 5 properties
        • checksTotalinteger

          How many controls apply to this project through its policy.

        • checksRuninteger

          How many of those controls have produced a counted verdict. A control that is unconfigured, or whose only verdict is NO_DATA, is not counted here.

        • checksFailinginteger

          How many of those controls have a failing latest verdict.

        • streakDaysinteger

          How many consecutive days the project has gone with no failing control.

        • lastAssessedAtstring | null

          When this project was most recently assessed, or null when it has never been assessed within the health window.

    • totalGovernanceProjectsinteger

      How many projects match the status filter across every page. This is the length of the filtered list, not the size of the organization — read governanceProjectPortfolio.total for that.

    • governanceProjectPortfolioobject

      An organization-wide roll-up of project statuses. The five bucket counts are mutually exclusive and sum to total, and the roll-up always covers the whole organization even when the accompanying list is filtered or paginated.

      Show 7 propertiesHide 7 properties
      • totalinteger

        How many projects your organization has in total.

      • healthyinteger

        How many projects have no failing control.

      • needsAttentioninteger

        How many projects have failing controls but a pass rate at or above the healthy threshold.

      • criticalinteger

        How many projects have failing controls and a pass rate below the healthy threshold.

      • awaitinginteger

        How many projects are enrolled in a policy but have never been assessed.

      • notEnrolledinteger

        How many projects belong to no governance policy.

      • aggregatePassRatenumber | null

        The share of passing checks across every enrolled project, from 0 to 100, or null when nothing has been assessed anywhere.

    • pageinteger

      The page this response covers.

    • pageSizeinteger

      The number of projects per page.

  • linkstring

    This is the URL of the resource on the Confident AI platform.

  • deprecatedboolean

    Indicates if this endpoint is deprecated.

Built byConfident AI