Get User List

Last Updated on : 2023-05-22 06:38:12download

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 name	Type	IN	Required	Description
schema	String	uri	true	The channel identifier of a specified app.
page_no	Integer	query	true	The current page number.
page_size	Integer	query	true	The number of rows per page. Valid values range from `0` to `100`.
username	String	query	false	The username.
start_time	Long	query	false	The 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_time	Long	query	false	The 10-digit timestamp of the end time. If `end_time` is Null, use `start_time` as the reference value.

Return parameter

Parameter name	Type	Description
result	PagedTotalVO	The returned result.

Description of result

Parameter name	Type	Description
list	List	A list of the returned value objects.
has_more	Boolean	Indicates whether additional data is available. Valid values: `true`: yes. `false`: no.
total	Long	The total number of users.

Description of list

Parameter name	Type	Description
uid	String	The user ID (UID).
username	String	The username.
mobile	String	The phone number (only available to users who have registered with a phone number).
email	String	The email address (only available to users who have registered with an email address).
create_time	Long	The creation time.
update_time	Long	The update time.
country_code	String	The 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.

Prev DocGet user information

Next DocDevice Control