Get Users with Filters
POST
/apis/v1/users/filter
Authorization
Permission:
Get User DataAvailable Fields
| Platform field | Field name |
|---|---|
| First Name | first_name |
| Last Name | last_name |
| Join date | join_date |
| Total XP | xp |
| Total Coins | coins |
Filter Options
The
filter parameter supports three types of filtering operations:1. Exact Match
2. Comparison Operators
Supported operators:
3. Range Queries
Pagination
The API supports two pagination methods:
Cursor-Based Pagination (Recommended)
1.
next_cursor when more results exist.2.
cursor parameter in subsequent requests to get the other pages.Page-Based Pagination
1.
total_pages and current_page.2.
page with the number in subsequent requests to get the specific page.Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/apis/v1/users/filter' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"fields": [
"email",
"join_date",
"first_name",
"last_name"
],
"filter": {
"join_date": {
"lte": "2025-08-28",
"gte": "2025-01-01"
},
"first_name": "Annie"
}
}'Response Response Example
200 - Success
{
"status": "success",
"data": {
"pagination": {
"total": 14,
"currentPage": 1,
"totalPages": 1,
"hasNextPage": false,
"hasPrevPage": false
},
"data": [
{
"email": "Test@gmail.com",
"join_date": "2025-03-03T03:24:54.828Z",
"first_name": "Test",
"last_name": "Lee"
},
...
{
"email": "coffeeplanetklee@outlook.com",
"join_date": "2025-02-13T04:44:56.067Z",
"first_name": "Klee",
"last_name": "Planet"
}
]
}
}Modified at 2026-03-24 09:39:51