get users by filter

Developing

POST

/apis/v1/users/filter

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

fields

array[string]

required

filter

object

required

object

required

join_date

object

required

customer

string

required

page

integer

required

limit

integer

required

Example

{
    "fields": [
        "email",
        "xp",
        "join_date"
    ],
    "filter": {
        "xp": {
            "gt": 100
        },
        "join_date": {
            "gte": "2025-07-20",
            "lte": "2025-07-28"
        },
        "customer": "true"
    },
    "page": 1,
    "limit": 100
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://integration.returning.ai/apis/v1/users/filter' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fields": [
        "email",
        "xp",
        "join_date"
    ],
    "filter": {
        "xp": {
            "gt": 100
        },
        "join_date": {
            "gte": "2025-07-20",
            "lte": "2025-07-28"
        },
        "customer": "true"
    },
    "page": 1,
    "limit": 100
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2025-07-30 05:56:20

user bulk import

Send Message