List all Users

GET/api/users

Headers

FieldTypeDescription
authtoken String Authentication token, generated from admin area

Parameters

FieldTypeDescription
user_type String optional Optional filter by user type (staff, client, lead)
status String optional Optional filter by status (active, inactive)
curl -X GET "https://yoursite.com/api/users" \
  -H "authtoken: YOUR_API_TOKEN"

Success-Response:

{
		"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"
}
MethodGET
Path/api/users
GroupUsers
Sincev1.0.0
Defined inRestApi/Controllers/UsersController.php