Get user list

Last Updated on : 2023-12-07 03:33:48download

Used to obtain user data associated with the IoT platform. The privacy fields in the data will be desensitized. The maximum time interval for obtaining data is 30 days.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
schema	String	uri	true	Application Name
page_no	Integer	query	true	Current page number
page_size	Integer	query	true	The number of rows per page size. Value range: 0~100
username	String	query	false	Username
start_time	Long	query	true	Start time, expressed in 10-digit timestamp
end_time	Long	query	true	Expiration time, expressed as a 10-digit timestamp

Return parameter

Parameter name	Type	Description
result	PagedTotalVO	Return result description

Description of result

Parameter name	Type	Description
list	List	Returned value object collection
has_more	Boolean	Determine whether there is more data. true: Yes false: No
total	Long	Total number of users

Description of list

Parameter name	Type	Description
uid	String	User UID
username	String	Username
country_code	String	Country Code
mobile	String	Mobile phone number (only support mobile phone number registered users)
email	String	E-mail (only support mailbox registered users)
nick_name	String	Nickname
avatar	String	Portrait
create_time	Long	Created time
update_time	Long	Update time
user_properties	List	User Attributes
time_zone_id	String	Time Zone ID
temp_unit	Integer	Temperature Unit

Description of user_properties

Parameter name	Type	Description
code	String	User attribute code
value	String	The value corresponding to the user attribute code

Request example

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

Return example

{
    "list": [
        {
            "mobile": "****",
            "country_code": "86",
            "uid": "ay15264******aK4Jo",
            "username": "****"
        },
        {
            "country_code": "86",
            "uid": "ay1526** ****09hBOKe",
            "email": "****",
            "username": "****"
        }
    ],
    " total": 2,
    "has_more": false
}

Error code

For more information, see error code.