Get User List

GET

https://api.main.xleadfunnel.com/v1/funnel-page-users/get-user-list

To get all users who have filled in a form (a particular page of a funnel) to join a campaign, it is by batches in terms of page number, sorted by time created.

Request

Query Params

funnel_page_id

string

required

The form that users joined in.

page

integer

optional

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

per_page

integer

optional

Number of records return for that page, maxiumum is 50. Default is 20.

Responses

🟢200Success

application/json

Body

integer

required

100 : OK
-100 : No users found

string

required

Return message in details

data

array [object {8}]

optional

Array of users

user_id

string

optional

name

string

optional

string

optional

country_code

string

optional

mobile

string

optional

gender

string

optional

status

string

optional

created

string

optional

Example

{
  "rc": 100,
  "rm": "OK",
  "users": [
    {
      "user_id": "6585fc9c2a7c2496c72bx28f",
      "name": "Peter Chan",
      "email": "peter.chan@gmail.com",
      "country_code": "852",
      "mobile": "98765432",
      "gender": "M",
      "status": "IMP",
      "created": "2023-10-19"
    },
    {
      "user_id": "6585sc9c2b7c2g96c72bv28f",
      "name": "Mary Chan",
      "email": "mary.chan@gmail.com",
      "country_code": "852",
      "mobile": "98765433",
      "gender": "F",
      "status": "IMP",
      "created": "2023-10-19"
    }
  ]
}

Modified at 2024-04-04 04:31:53

Delete User

Get User (Coming Soon)