# Users

## List all users

`client.users.list(UserListParamsquery?, RequestOptionsoptions?): CursorPagination<User>`

**get** `/users`

Retrieve a paginated list of users using cursor-based pagination

### Parameters

- `query: UserListParams`

  - `after?: string`

    Cursor for forward pagination. Returns items after this cursor.

  - `before?: string`

    Cursor for backward pagination. Returns items before this cursor.

  - `limit?: number`

    Maximum number of items to return

### Returns

- `User`

  - `id: string`

    Unique identifier with user_ prefix

  - `created_at: string`

    Timestamp when the user was created

  - `email: string`

    Email address of the user

  - `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

### Example

```typescript
import Luminary from 'withluminary';

const client = new Luminary();

// Automatically fetches more pages as needed.
for await (const user of client.users.list()) {
  console.log(user.id);
}
```

#### Response

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

## Get a user by ID

`client.users.retrieve(stringid, RequestOptionsoptions?): User`

**get** `/users/{id}`

Retrieve detailed information about a specific user

### Parameters

- `id: string`

### Returns

- `User`

  - `id: string`

    Unique identifier with user_ prefix

  - `created_at: string`

    Timestamp when the user was created

  - `email: string`

    Email address of the user

  - `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

### Example

```typescript
import Luminary from 'withluminary';

const client = new Luminary();

const user = await client.users.retrieve('id');

console.log(user.id);
```

#### Response

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

## Domain Types

### User

- `User`

  - `id: string`

    Unique identifier with user_ prefix

  - `created_at: string`

    Timestamp when the user was created

  - `email: string`

    Email address of the user

  - `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