Get User List by Last Modified Time

Last Updated on : 2023-06-20 15:38:32download

Get the list of users based on the last modified time. last_modified_time is not required on the first request. The subsequent requests rely on the last_modified_time returned by the previous request. There is an intersection of the results returned by two adjacent requests of this API.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
schema	String	uri	true	The schema of a specified app.
page_size	Integer	query	false	The number of items returned on each page. The value range is `0` to `1000`. Default value: `100`.
last_modified_time	Long	query	false	The 10-digit timestamp of the last modification time. Note: The first request does not pass the `last_modified_time`, and the `last_modified_time` returned by the previous request will be passed since the second request.

Return parameter

Parameter name	Type	Description
result	PagedLastIdVO	The returned value.

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.
last_modified_time	Long	The time when it is modified last time.

Description of list

Parameter name	Type	Description
uid	String	The user ID (UID).
username	String	The username.
country_code	String	The country code.
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 time when it is created.
update_time	Long	The time when it is updated.

Request example

GET: /v2.1/apps/testApp/users?page_size=100&last_modified_time=1602848780

Return example

{
    "lastModifiedTime": 1602848790,
    "list": [
        {
            "mobile": "****",
            "country_code": "86",
            "uid": "ay15264******aK4Jo",
            "update_time": 1638871191,
            "email": "****",
            "username": "****"
        },
        {
            "country_code": "86",
            "uid": "ay1526******09hBOKe",
            "email": "****",
            "username": "****"
        }
    ],
    "has_more": false
}

Error code

For more information, see error code.