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.
Get API Key
GuidesAPI Reference
GuidesAPI Reference
  • Overview
    • API Reference
  • Endpoint Reference
    • Organizations
    • Projects
    • Documents
    • Agent
    • Check
  • API Explorer
      • GETGet a project by ID
      • DELDelete a project
      • PATCHUpdate a project
      • GETList Connect projects
      • POSTCreate a new Connect project
Get API Key
LogoLogo
API ExplorerProjects

List Connect projects

GET
/api/v2/projects
GET
/api/v2/projects
$curl https://api-staging.pyramid-ai.com/api/v2/projects \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json"
1{
2 "request_id": "req_4a7f8e9d2c3b1a0f5e6d",
3 "success": true,
4 "data": [
5 {
6 "id": "proj_9f8b7c6d5e4a3b2c1d0e",
7 "org_id": "org_ais",
8 "name": "Customer Insights Analysis",
9 "description": "Project for analyzing customer feedback and behavior patterns.",
10 "document_count": 42,
11 "created_at": "2024-01-15T09:30:00Z",
12 "updated_at": "2024-04-10T16:45:00Z"
13 }
14 ],
15 "pagination": {
16 "total": 127,
17 "offset": 0,
18 "limit": 50
19 }
20}

Returns all projects accessible by the authenticated API key’s organization. Results are paginated — use limit and offset to page through large lists.

Was this page helpful?
Previous

Create a new Connect project

Next
Built with

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Query parameters

limitintegerOptional<=200Defaults to 50
offsetintegerOptionalDefaults to 0

Response

List of projects
request_idstringformat: "uuid"

Server-generated per-request UUID. Also sent as X-Request-Id response header. Include in support tickets.

successany
datalist of objects
paginationobject

Offset-based pagination for list endpoints. Clients compute has_more from offset + data.length < total. Cursor pagination may be added per-endpoint later if deep-pagination performance becomes a concern.

Errors

400
Bad Request Error
401
Unauthorized Error