Get User List

Last Updated on : 2023-06-20 14:37:06download

Based on users' creation time, get the app user data under the developer's account. The data of up to 30 days can be obtained. We recommend that start_time and end_time be filled with a specified time range. Do not enter Null.

API address

GET: /v2.0/apps/{schema}/users

Request parameter

Parameter nameTypeINRequiredDescription
schemaStringuritrueThe channel identifier of a specified app.
page_noIntegerquerytrueThe current page number.
page_sizeIntegerquerytrueThe number of rows per page. Valid values range from 0 to 100.
usernameStringqueryfalseThe username.
start_timeLongqueryfalseThe 10-digit timestamp of the start time.
  • If start_time is Null, use end_time as the reference value.
  • If start_time = end_time = Null, by default, end_time is the current time and start_time is the current time minus 30 days.
end_timeLongqueryfalseThe 10-digit timestamp of the end time.
If end_time is Null, use start_time as the reference value.

Return parameter

Parameter nameTypeDescription
resultPagedTotalVOThe returned result.

Description of result

Parameter nameTypeDescription
listListA list of the returned value objects.
has_moreBooleanIndicates whether additional data is available. Valid values:
  • true: yes.
  • false: no.
totalLongThe total number of users.

Description of list

Parameter nameTypeDescription
uidStringThe user ID (UID).
usernameStringThe username.
mobileStringThe phone number (only available to users who have registered with a phone number).
emailStringThe email address (only available to users who have registered with an email address).
create_timeLongThe creation time.
update_timeLongThe update time.
country_codeStringThe code of a specified country or region.

Request example

GET: /v2.0/apps/testApp/users?page_no=1&page_size=10&start_time=1602848780&end_time=1603809946

Return example

    "list": [
            "create_time": 1602848780,
            "mobile": "****",
            "uid": "ay15264******aK4Jo",
            "country_code": "86",
            "update_time": 1602848780,
            "username": "****"
            "create_time": 1602848780,
            "uid": "ay1526******09hBOKe",
            "country_code": "86",
            "update_time": 1602848780,
            "email": "****",
            "username": "****"
    "total": 2,
    "has_more": false

Error code

For more information, see error code.