List all users

get/users

Retrieve a paginated list of users using cursor-based pagination

Query ParametersExpand Collapse

after: optional string

Cursor for forward pagination. Returns items after this cursor.

before: optional string

Cursor for backward pagination. Returns items before this cursor.

limit: optional number

Maximum number of items to return

maximum1000

minimum1

ReturnsExpand Collapse

data: array of User { id, created_at, email, 3 more }

id: string

Unique identifier with user_ prefix

created_at: string

Timestamp when the user was created

formatdate-time

email: string

Email address of the user

formatemail

first_name: string

First name of the user

last_name: string

Last name of the user

updated_at: string

Timestamp when the user was last updated

formatdate-time

page_info: PageInfo { has_next_page, has_previous_page, end_cursor, start_cursor }

has_next_page: boolean

When paginating forwards, are there more items?

has_previous_page: boolean

When paginating backwards, are there more items?

end_cursor: optional string

Cursor pointing to the last item in the current page

start_cursor: optional string

Cursor pointing to the first item in the current page

total_count: number

Total number of items matching the query (across all pages)

List all users

curl https://$WITHLUMINARY_SUBDOMAIN.withluminary.com/api/public/v1/users

{
  "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

{
  "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
}