Get Users - Jeff Program Testing

请求参数

Query 参数

page

integer

可选

Indicate the starting page number for retrieving user records. Default is 1.

per_page

integer

可选

Maxiumum is 50. Default is 20.

Header 参数

x-api-key

string

必需

API key of your funnel account.

示例值:

DmxPFlWX1H*Ag$IuHOaNKQwHp$JWa^l93oKuOpu4Xg5zYmWPER%#P34&LUwD!B!9

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/users?page=&per_page=' \
--header 'x-api-key: DmxPFlWX1H*Ag$IuHOaNKQwHp$JWa^l93oKuOpu4Xg5zYmWPER%#P34&LUwD!B!9'

返回响应

🟢200Success

application/json

Body

rc

integer

可选

100 : OK
-100 : Not found

rm

string

可选

Return message in details

users

array [object {17}]

可选

User records in array and for multi users

_id

string

可选

acct_id

string

可选

funnel_id

string

可选

name

string

可选

email

string

可选

country_code

string

可选

mobile

string

可选

gender

string

可选

address

string

可选

birthday

object

可选

visitor_id

string

可选

join_medium

string

可选

user_tags

array [object {1}]

可选

country_id

string

可选

status

string

可选

created

string

可选

modified

string

可选

示例

{
    "rc": 100,
    "rm": "OK",
    "users": [
        {
            "_id": "64f5313f35e6a55fcccccccc",
            "acct_id": "64f5313f35e6a55faaaaaaaa",
            "funnel_id": "64f5313f35e6a55faaaaaaac",
            "name": "Peter Chan",
            "email": "peter.chan@gmail.com",
            "country_code": "852",
            "mobile": "98765432",
            "gender": "M",
            "address": "Address 123",
            "birthday": {
                "byear": "2000",
                "bmonth": "01",
                "bday": "10"
            },
            "visitor_id": "",
            "join_medium": "FB",
            "user_tags": [
                {
                    "value": "Testing"
                }
            ],
            "country_id": "CR-HK",
            "status": "IMP",
            "created": "2023-10-19",
            "modified": "2023-10-19"
        },
        {
            "_id": "64f5313f35e6a55fcccccccd",
            "acct_id": "64f5313f35e6a55faaaaaaab",
            "name": "Mary Chan",
            "email": "mary.chan@gmail.com",
            "country_code": "852",
            "mobile": "98765433",
            "gender": "F",
            "address": "Address 124",
            "birthday": {
                "byear": "2000",
                "bmonth": "03",
                "bday": "10"
            },
            "visitor_id": "",
            "join_medium": "FB",
            "user_tags": [
                {
                    "value": "Testing"
                }
            ],
            "country_id": "CR-HK",
            "status": "IMP",
            "created": "2023-10-19",
            "modified": "2023-10-19"
        }
    ]
}