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.
DashboardWebsiteCommunity
DocsAPI ReferenceChangelog
DocsAPI ReferenceChangelog
  • API Reference
      • GETList Reporting Groups
      • POSTCreate Reporting Group
      • GETGet Reporting Group
      • POSTUpdate Reporting Group
      • DELDelete Reporting Group
  • External Links
    • Agent API Docs
    • OpenAPI Spec
LogoLogo
DashboardWebsiteCommunity
API ReferenceReporting Groups

List Reporting Groups

GET
/org/:org_id/project/:project_id/reporting-groups
GET
/api/v1/org/:org_id/project/:project_id/reporting-groups
$curl https://app.rightbrain.ai/api/v1/org/123e4567-e89b-12d3-a456-426614174000/project/123e4567-e89b-12d3-a456-426614174001/reporting-groups \
>     -H "Authorization: Bearer <token>"
1{
2  "results": [
3    {
4      "name": "string",
5      "id": "string",
6      "project_id": "string",
7      "created": "string",
8      "modified": "string",
9      "description": "string"
10    }
11  ],
12  "pagination": {
13    "next_cursor": "019097c5-5560-05b5-4a48-5197a269683b",
14    "has_next": true,
15    "page_limit": 100
16  }
17}

List all reporting groups within a project.

Returns a paginated list of reporting groups ordered by creation date (newest first). Use the cursor and page_limit parameters to navigate through large result sets.

Was this page helpful?
Previous

Create Reporting Group

Next
Built with

Authentication

AuthorizationBearer

Bearer token authentication using JWT tokens from Ory Kratos/Hydra

Path parameters

org_idstringRequiredformat: "uuid"
The unique identifier of the organization.
project_idstringRequiredformat: "uuid"
The unique identifier of the project.

Query parameters

cursorstringOptional
Pagination cursor for the next page of results.
page_limitintegerOptional1-100Defaults to 100
Maximum number of reporting groups to return per page.

Response

Successful Response
resultslist of objects
The list of items returned for the current page.
paginationobject or null
Contains pagination information for the result set.

Errors

400
Bad Request Error
403
Forbidden Error
422
Unprocessable Entity Error