Search Users
Use this method to cursor through a list of users.
This method requires authentication.
Use this method to cursor through a list of users. This method will return users in the order in which they were created, so it is safe to add new users while cursoring through the list.
ARGUMENTS
- cursor: Each call to ListUsers will return a result set with a 'nextCursor' value. To get the next page of users, pass this value as the optional 'cursor' property. To get the first page of users, omit the 'cursor' argument.
- limit: You can omit this optional argument, in which case the default limit is 200 users to return.
- name: Provide part of a name to search the user name field
- handle: Provide part of a handle to search by handle
- userid: Provide part of a userid to search by userid
Parameters
Values in the path and query string.
appid path The application whose users are searched.
Example:your-app-id JSON body
Send as application/json.
userId Optional. Part of a userid to search by userid. Takes priority over handle and name if more than one is supplied.
handle Optional. Part of a handle to search by handle partial match . Used only if userid is not supplied.
name Optional. Part of a display name to search the name field partial match . Used only if neither userid nor handle is supplied.
limit Optional. Maximum number of users to return. Defaults to 20 if omitted.
cursor Optional. Pass the cursor value from a previous response to continue paging a handle/name search; omit to start from the first page.
{
"handle": "dave_m",
"limit": 100
}Common variations
Historical examples filtered through the current request schema.
Search Users (By Handle)
{
"handle": "dave_m",
"limit": 100
}Search Users (By Name)
{
"name": "Washington",
"limit": 100
}Search Users (By UserId)
{
"limit": 100
}Status codes
Every JSON response uses the API result envelope.
200 OK: success data is { kind: "list.users", cursor, users } . ApiResult 400 BadRequest: none of userid, handle, or name was provided. ApiResult 403 Forbidden: request is not authorized with a valid token, or the token does not match this appid. ApiResult 500 Internal Server Error ApiResult