API Reference

Users

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List all users

users.list(UserListParams**kwargs) -> SyncCursorPagination[User]

GET/users

Retrieve a paginated list of users using cursor-based pagination

ParametersExpand Collapse

after: Optional[str]

Cursor for forward pagination. Returns items after this cursor.

before: Optional[str]

Cursor for backward pagination. Returns items before this cursor.

limit: Optional[int]

Maximum number of items to return

maximum1000

minimum1

ReturnsExpand Collapse

class User: …

id: str

Unique identifier with user_ prefix

created_at: datetime

Timestamp when the user was created

formatdate-time

email: str

Email address of the user

formatemail

first_name: str

First name of the user

last_name: str

Last name of the user

updated_at: datetime

Timestamp when the user was last updated

formatdate-time

List all users

Python

HTTP

TypeScript

Python

Go

from withluminary import Luminary

client = Luminary()
page = client.users.list()
page = page.data[0]
print(page.id)

200 example

{
  "data": [
    {
      "id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "email": "jane.doe@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "updated_at": "2024-01-20T14:45:00Z"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9",
    "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9"
  },
  "total_count": 100
}

Returns Examples

200 example

{
  "data": [
    {
      "id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "email": "jane.doe@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "updated_at": "2024-01-20T14:45:00Z"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9",
    "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9"
  },
  "total_count": 100
}