> ## Documentation Index
> Fetch the complete documentation index at: https://www.orwel.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List Users

> Retrieve a paginated list of workspace members

> [!NOTE]
>
> Requires an [API key](https://www.orwel.io/docs/authentication.md) (`orwel_sk_`) with the `leads:read` scope.

## Query Parameters

**limit** `integer` (default: 50)

Maximum number of results to return (max: 100)

**offset** `integer` (default: 0)

Number of results to skip for pagination

**role** `string`

Filter users by role (e.g., "admin", "member", "viewer")

## Response

**data** `array`

Array of workspace user objects

**User Object**

**id** `string`

Unique identifier for the user

**email** `string`

User's email address

**name** `string`

User's full name

**avatar** `string`

URL to user's avatar image

**username** `string`

User's username

**language** `string`

User's preferred language

**created\_at** `string`

ISO 8601 timestamp of user account creation

**workspace\_role** `string`

User's role in the workspace

**joined\_at** `string`

ISO 8601 timestamp when user joined the workspace

**pagination** `object`

Pagination information

**Pagination Object**

**limit** `integer`

Number of results per page

**offset** `integer`

Current offset

**total** `integer`

Total number of users in the workspace

```bash cURL theme={null}
curl -X GET "https://api.orwel.io/api/v1/users?limit=10" \
  -H "Authorization: Bearer orwel_sk_YOUR_KEY"
```

```javascript JavaScript theme={null}
const response = await fetch(
  'https://api.orwel.io/api/v1/users?limit=10',
  {
    headers: {
      'Authorization': 'Bearer orwel_sk_YOUR_KEY'
    }
  }
);

const data = await response.json();
console.log(data);
```

```python Python theme={null}
import requests

headers = {
    'Authorization': 'Bearer orwel_sk_YOUR_KEY'
}

params = {
    'limit': 10
}

response = requests.get(
    'https://api.orwel.io/api/v1/users',
    headers=headers,
    params=params
)

data = response.json()
print(data)
```

```json Response theme={null}
{
  "data": [
    {
      "id": "cc0e8400-e29b-41d4-a716-446655440007",
      "email": "john@example.com",
      "name": "John Doe",
      "avatar": "https://example.com/avatar.jpg",
      "username": "johndoe",
      "language": "en",
      "created_at": "2024-06-15T10:30:00Z",
      "workspace_role": "admin",
      "joined_at": "2024-06-15T10:30:00Z"
    },
    {
      "id": "dd0e8400-e29b-41d4-a716-446655440008",
      "email": "jane@example.com",
      "name": "Jane Smith",
      "avatar": "https://example.com/avatar2.jpg",
      "username": "janesmith",
      "language": "en",
      "created_at": "2024-07-20T14:20:00Z",
      "workspace_role": "member",
      "joined_at": "2024-07-20T14:20:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 5
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.