01
Introduction
User Management APIs

The User Management APIs allow you to manage user accounts, assign Spatie roles, and upload profile pictures. All requests require authentication and appropriate permissions.

🔐 Requires a valid Bearer token in the Authorization header.
02
List Users
Get a paginated list of all users
GET /api/users/index List users ▶
Query Parameters
Field Type Status Description
per_page integer optional Number of items per page (default: 10)
page integer optional Page number to retrieve
03
Create User
Create a new user with Spatie roles
POST /api/users/store Create user ▶
Body Parameters (FormData / JSON)
Field Type Status Description
name string required User's full name
email string required Valid unique email address
password string required Min 8 characters
password_confirmation string required Must match password
first_name string optional User's first name
last_name string optional User's last name
registeration date optional Registration date (YYYY-MM-DD)
company_name string optional Associated company name
is_allowed_ims boolean optional 1 or 0
is_allowed_order boolean optional 1 or 0
user_type string required e.g. admin, customer, vendor
status string optional e.g. active, inactive
roles[] array optional Array of Spatie role names
file file optional Profile image (jpeg, png, jpg)
04
Get User
Retrieve a specific user's details
GET /api/users/show/{id} Get user ▶
URL Parameters
Field Type Status Description
id integer required User ID
05
Update User
Update user information and roles
PUT /api/users/update/{id} Update user ▶
Body Parameters (FormData / JSON)

Accepts the same fields as the store endpoint. All fields are optional.

06
Delete User
Permanently delete a user account
DELETE /api/users/delete/{id} Delete user ▶
URL Parameters
Field Type Status Description
id integer required User ID to delete