Users

Route	Capability	Description
List users GET /users	users-list	List all users with pagination.
Get user GET /users/:user_id	users-detail	Get details of an user.
Create a user POST /users	users-create	Create a user with given information.
Update a user PUT /users/:users_id	users-update	Update an existing user.
Mark as active POST /users/:users_id/active	users-activation	Mark a user as active.
Mark as inactive POST /users/:users_id/inactive	users-activation	Mark a user as inactive.
Mark as blocked POST /users/:users_id/block	users-blockable	Mark a user as blocked.
Mark as unblocked POST /users/:users_id/unblock	users-blockable	Mark a user as unblocked.

List users

GET users 

List all users with pagination.

Parameters

Parameter	Type	Information
firstName	string	Search users by users firstName. Variants: firstName_startswith and firstName_contains
lastName	string	Search users by lastName. Variants: lastName_startswith and lastName_contains
filter_by	string	Filter users by status. Standard on active. Allowed Values: all, active, inactive
search_text	string	Search users by users firstName or lastName.
sort_column	string	Sort users. Standard on lastName. Allowed Values: email,firstName,lastName,phone created_at and updated_at
sort_order	string	Sort order. Standard on ASC Allowed Values: ASC,DESC
limit	integer	Limit page list Standard on 25 Allowed Maximum Value: 200

Get user

GET users/:users_id 

Get details of a user.

Create a user

POST users 

Create a user with given information.

Request attributes

Field	Type	Information
email	string [255]	required, must be unique, must be a valid email address
firstName	string [100]	required
lastName	string [100]	required
phone	string [255]	required

Sample Request

{
	"email":"Wannes@vsrs.be",
	"firstName":"Wannes",
	"lastName":"Garrevoet",
	"phone":"+32411111111"
}

Update a user

PUT  users/:users_id 

Update an existing users.

Request attributes

Field	Type	Information
firstName	string [100]	required
lastName	string [100]	required
phone	string [255]	required

Sample Request

{
	"firstName":"Wannes",
	"lastName":"Van Vracem",
	"phone":"+32411111111"
} 

Mark as active

POST users/:users_id/active 

Mark a user as active.

Mark as inactive

POST users/:users_id/inactive 

Mark a user as inactive.

Mark as blocked

POST users/:users_id/block 

Mark a user as blocked.

Mark as unblocked

POST users/:users_id/unblock 

Mark a user as unblocked.