ZapAPI Docs
Get StartedConceptsAI GatewayGuidesPayment GatewaySDKAPI ReferenceResources
ApiUsers

Advanced search for users

GET
/api/v1/users/search/advanced

Search users with filters (search query, active status), sorting, and pagination.

Authorization

bearer

Query Parameters

search?string

Search query for name or email

isActive?string

Filter by active status

sortBy?string

Sort by field

Value in"email""firstName""lastName""createdAt""isActive"
sortOrder?string

Sort direction

Value in"asc""desc"
page?number

Page number

Range1 <= value
limit?number

Items per page

Range1 <= value

Header Parameters

X-API-Version?string

API version for header-based versioning

Default"1"
Value in"1""2"

Response Body

Users search results with filters and pagination.

response?unknownapplication/json
Example Request
curl -X GET 'http://localhost:3001/api/v1/users/search/advanced'
Example Response200
{  "status": "success",  "statusCode": 200,  "message": "Users searched successfully",  "data": [    {      "id": "6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe",      "email": "john.doe@example.com",      "firstName": "John",      "lastName": "Doe",      "isActive": true,      "createdAt": "2026-01-27T10:23:22.983Z",      "updatedAt": "2026-01-27T10:23:22.983Z"    }  ],  "meta": {    "total": 15,    "count": 10,    "page": 1,    "limit": 10,    "total_pages": 2,    "has_next": true,    "has_previous": false,    "search_query": "john",    "filters": {      "isActive": "true"    },    "sort": {      "field": "email",      "order": "asc"    }  },  "timestamp": "2026-01-27T10:40:00.000Z",  "path": "/api/v1/users/search/advanced"}