Skip to content
Product Docs

List Organizations

organizations.list(OrganizationListParams**kwargs) -> SyncPaginatedCursor[Organization]
GET/api/v2/organizations

List organizations the current user can access.

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

API response schema for an organization.

id: str

The organization’s unique identifier.

name: str

The organization’s display name.

created_at: Optional[datetime]

Creation datetime

formatdate-time
metadata: Optional[Dict[str, object]]

Additional organization metadata.

updated_at: Optional[datetime]

Update datetime

formatdate-time

List Organizations

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.organizations.list()
page = page.items[0]
print(page.id)
{
  "items": [
    {
      "id": "id",
      "name": "name",
      "created_at": "2019-12-27T18:11:19.117Z",
      "metadata": {
        "foo": "bar"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "name": "name",
      "created_at": "2019-12-27T18:11:19.117Z",
      "metadata": {
        "foo": "bar"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}