Skip to content
Product Docs

List Invites

invites.list_mine(InviteListMineParams**kwargs) -> SyncPaginatedCursor[Invite]
GET/api/v2/invites

List the current user’s pending invitations, cursor-paginated.

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

A pending invitation visible to the invitee.

id: str

The invite’s unique identifier.

organization_id: str

The organization the user is invited to.

organization_name: str

The organization’s display name.

role: str

The role being granted (e.g. admin, viewer).

created_at: Optional[datetime]

Creation datetime

formatdate-time
updated_at: Optional[datetime]

Update datetime

formatdate-time

List Invites

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.invites.list_mine()
page = page.items[0]
print(page.id)
{
  "items": [
    {
      "id": "id",
      "organization_id": "organization_id",
      "organization_name": "organization_name",
      "role": "role",
      "created_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "organization_id": "organization_id",
      "organization_name": "organization_name",
      "role": "role",
      "created_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}