Skip to content
Product Docs

List Projects

projects.list(ProjectListParams**kwargs) -> SyncPaginatedCursor[Project]
GET/api/v2/projects

List projects in an organization. Requires organization_id or a project-scoped API key.

ParametersExpand Collapse
name: Optional[str]
organization_id: Optional[str]
page_size: Optional[int]
page_token: Optional[str]
ReturnsExpand Collapse
class Project:

API response schema for a project.

id: str

The project’s unique identifier.

name: str

The project’s display name.

organization_id: str

The organization the project belongs to.

created_at: Optional[datetime]

Creation datetime

formatdate-time
is_default: Optional[bool]

Whether this project is the default project for its organization.

updated_at: Optional[datetime]

Update datetime

formatdate-time

List Projects

import os
from llama_cloud_admin import LlamaCloudAdmin

client = LlamaCloudAdmin(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
page = client.projects.list()
page = page.items[0]
print(page.id)
{
  "items": [
    {
      "id": "id",
      "name": "name",
      "organization_id": "organization_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "is_default": true,
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "name": "name",
      "organization_id": "organization_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "is_default": true,
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}