# GET /api/users

> Users - List all Users

- **Endpoint:** `GET /api/users`
- **Group:** Users
- **Since:** v1.0.0
- **Defined in:** `RestApi/Controllers/UsersController.php`

## Headers

| Field | Type | Description |
| --- | --- | --- |
| `authtoken` | String | Authentication token, generated from admin area |

## Parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `user_type` | String | no | Optional filter by user type (staff, client, lead) |
| `status` | String | no | Optional filter by status (active, inactive) |

## Request example

```bash
curl -X GET "https://yoursite.com/index.php/api/users" \
  -H "authtoken: YOUR_API_TOKEN"
```

## Responses

### Success - Success-Response:

```json
{
		"id": "1",
		"first_name": "John",
		"last_name": "Doe",
		"user_type": "staff",
		"is_admin": "1",
		"role_id": "0",
		"email": "john@example.com",
		"image": null,
		"status": "active",
		"client_id": "0",
		"is_primary_contact": "0",
		"job_title": "Admin",
		"phone": "1234567890",
		"gender": "male",
		"created_at": "2021-09-12 10:00:00"
}
```

---

Part of the [REST API for RISE CRM](https://risecrm.themesic.com/apiguide/) documentation.
Full page: https://risecrm.themesic.com/apiguide/users/get-users/