GET Users & notifications
List 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.
Request
Parameters
Values in the path and query string.
appid path string TalkLabs ID required
The application whose users are listed.
Example:your-app-id Cursor query string
Optional. Pass the cursor value from a previous response to fetch the next page; omit to start from the first page.
Limit query integer · int32
Optional. Maximum number of users to return in this page. Default and maximum are both 200 values above 200 are rejected with 400.
Example:200 Response
Status codes
Every JSON response uses the API result envelope.
200 OK: success data is a ResponseCursorListAppUsers cursor/more/itemcount/users . ApiResult 400 BadRequest: limit exceeds the maximum allowed value of 200. 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 Example response · 200
{
"message": "Success",
"errors": {},
"data": {
"kind": "list.users",
"cursor": "|5ebbe03d5617e00de4b044c2",
"users": [
{
"kind": "app.user",
"userid": "userid_abe",
"handle": "HonestAbe",
"handlelowercase": "honestabe",
"displayname": "Abraham Lincoln",
"pictureurl": "https://www.biography.com/.image/ar_1:1%2Cc_fill%2Ccs_srgb%2Cg_face%2Cq_auto:good%2Cw_300/MTU5MDUzMTE0Mzk2MTI0OTUy/abraham-lincoln-1809---18652c-sixteenth-president-of-the-united-states-of-america-photo-by-stock-montagestock-montagegetty-images_promo.jpg",
"profileurl": "https://www.biography.com/us-president/abraham-lincoln",
"banned": false
},
{
"kind": "app.user",
"userid": "u-8842",
"handle": "dave_m",
"handlelowercase": "georgew",
"displayname": "Dave M.",
"pictureurl": "https://example.com/users/u-8842s/photos/original/a9/c7/a6/44-1-george-washington-18-1549729902.jpg",
"profileurl": "https://example.com/users/u-8842shington",
"banned": false
},
{
"kind": "app.user",
"userid": "userid_thomasj",
"handle": "TJ",
"handlelowercase": "tj",
"displayname": "Thomas Jefferson",
"pictureurl": "https://www.biography.com/.image/ar_1:1%2Cc_fill%2Ccs_srgb%2Cg_face%2Cq_auto:good%2Cw_300/MTY2NzAyNTE0NTAxMDY3ODMx/thomas-jefferson_editedjpg.jpg",
"profileurl": "https://www.biography.com/us-president/thomas-jefferson",
"banned": false
},
{
"kind": "app.user",
"userid": "",
"handle": "ag_",
"handlelowercase": "ag_",
"displayname": "",
"pictureurl": "",
"profileurl": "",
"banned": false
}
]
}
}