ورود | ثبت نام
- FA
- EN
GET /api/v1/usersRetrieve a paginated list of users, with support for advanced filtering and sorting.
| Permission | Description |
|---|---|
users.view_all | View all users with full information |
users.view_limited | View users with limited information (requires search parameter) |
Note: Users with users.view_limited permission but not users.view_all must provide at least one character in the search parameter, otherwise the API will return 0 results.
| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number for pagination |
search | string | No* | Search text in user's name, email, username, or phone. Required for limited access users |
email_status | string | No | Filter by email verification status: verified or not_verified |
phone_status | string | No | Filter by phone verification status: verified or not_verified |
user_id | array | No | Filter by one or more specific user IDs |
sort_by | string | No | Sort by: name, email, phone, created_at, email_verified_at, phone_verified_at |
sort_order | string | No | Sort order: desc (default) or asc |
*Required when user has users.view_limited permission but not users.view_all
Default sort is by created_at (newest first).
{
"data": [
{<user resource>},
...
],
"links": {<pagination data>},
"meta": {<pagination data>}
}
