URL: v3/user-export-data

Method: GET

Description : Fetches list of users

Parameters:

Parameter Type Optional/Required Description
search-query string Optional Search Query
sort-order string Optional ‘asc’ or ‘desc’
sort-field string Optional User’s field based on which sorting will be done. By default, it is set to id.
limit integer Optional Number of records needed in a page.
page integer Optional Page number by default, it is set to 1.
active integer Optional Active value 1, Deactivate value 0
roles array Optional User role ids
created_at string Optional last::10~minutelast::10~hour

last::10~day

last::10~month

date::2026-03-23 00:30:00~2026-03-30 20:30:00

dept-ids array Optional Department ids
team-ids array Optional Team ids

Success Response :

{

 "success": true,

 "data": {

"current_page": 2,

"first_page_url": "http://localhost:8000/user-export-data?page=1",

"from": 3,

"last_page": 4,

"last_page_url": "http://localhost:8000/user-export-data?page=4",

"next_page_url": "http://localhost:8000/user-export-data?page=3",

"path": "http://localhost:8000/user-export-data",

"per_page": 2,

"prev_page_url": "http://localhost:8000/user-export-data?page=1",

"to": 4,

"total": 7,

"users": [

  {

user_name: '<a href="http://localhost:8000/user/4">alan@gmail.com</a>'
email: "alan@gmail.com"
id: 4
first_name: "Alan"
last_name: "Walker"
country_code: "+91"
mobile: "9876543210"
name: "<a href='http://localhost:8000/user/4"'>Alan Walker</a>"
organizations: "--"
roles: "User, Organization User"
view_url: "/user/4"
edit_url: "/user/4/edit"
full_name: "Alan Walker"
meta_name: "Alan Walker <alan@gmail.com>"
email_verified: true
mobile_verified: true
  },
]

   }

}

Error Response :

{

"success":false,

"Message":"No data available in table"

}
Tagged: