get
https://demo-api.edfapay.com/api/v1/users/search
Search & Retrieve Users, ACCESS LEVEL: SUPER_ADMIN, PARTNER, MERCHANT, BRANCH
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Retrieve a paginated list of users with optional filtering.
Endpoint
GET https://demo-api.edfapay.com/api/v1/users/search
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| pageNumber | Integer | Yes | Page number (starts from 0) |
| pageSize | Integer | Yes | Number of records per page |
| text | String | No | Search keyword |
| active | Boolean | No | Filter active users |
Request Example
curl --location 'https://demo-api.edfapay.com/api/v1/users/search?pageNumber=0&pageSize=10&text=test&active=true' \
--header 'X-API-KEY: <Your API Key>'Response Body
| Field | Type | Description |
|---|---|---|
| code | Integer | Response code |
| message | String | Status message |
| data.content | Array | List of users |
| data.content[].id | UUID | User ID |
| data.content[].username | String | Email/username |
| data.content[].firstName | String | First name |
| data.content[].lastName | String | Last name |
| data.content[].phoneNumber | String | Phone |
| data.content[].userType | String | User type |
| data.number | Integer | Page number |
| data.size | Integer | Page size |
| data.totalElements | Integer | Total records |
| data.totalPages | Integer | Total pages |
Response Example
{
"code": 200,
"message": "Success",
"data": {
"content": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"username": "[email protected]",
"firstName": "Test",
"lastName": "User",
"phoneNumber": "+966-500000000",
"userType": "USER"
}
],
"number": 0,
"size": 10,
"totalElements": 1,
"totalPages": 1
}
}