For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Trust CenterStatusSupportGet a demoPlatform
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
    • Data Models
    • API Conventions
  • Data Models
      • GETList Projects
      • POSTCreate Project
      • GETRetrieve Project
      • PUTUpdate Project
      • DELDelete Project
        • GETList Project Roles
        • POSTCreate Project Role
        • PUTUpdate Project Role
        • DELDelete Project Role
  • Evals
  • Legacy
LogoLogo
Trust CenterStatusSupportGet a demoPlatform
Data ModelsProjectsRoles

List Project Roles

GET
https://api.confident-ai.com/v1/projects/:projectId/roles
GET
/v1/projects/:projectId/roles
$curl https://api.confident-ai.com/v1/projects/projectId/roles \
>     -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"
200Retrieved
1{
2  "success": true,
3  "data": {
4    "roles": [
5      {
6        "id": "project-role-uuid-1",
7        "name": "Owner",
8        "description": "Owner of the project with full access to all resources.",
9        "projectId": null,
10        "policies": []
11      },
12      {
13        "id": "project-role-uuid-3",
14        "name": "Analyst",
15        "description": "Read-only project access",
16        "projectId": "PROJECT-ID",
17        "policies": [
18          {
19            "id": "policy-uuid-1",
20            "name": "View traces"
21          }
22        ]
23      }
24    ]
25  }
26}

Lists the roles available to a project. This includes both global, system-defined roles (where projectId is null) and custom roles defined for the project.

Was this page helpful?
Previous

Create Project Role

Next
Built with

Path parameters

projectIdstringRequired
The unique identifier of the project.

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Response

successboolean
Indicates if the request was successful
dataobject