Current section
Files
Jump to
Current section
Files
priv/docs/methods/users.list.json
{
"args": {
"cursor": {
"desc": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.",
"example": "dXNlcjpVMDYxTkZUVDI=",
"required": false,
"type": "string"
},
"include_locale": {
"desc": "Set this to `true` to receive the locale for users. Defaults to `false`",
"required": false,
"type": "boolean"
},
"limit": {
"desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no `limit` value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience `limit_required` or HTTP 500 errors. 0",
"example": "20",
"required": false,
"type": "number"
},
"team_id": {
"desc": "encoded team id to list users in, required if org token is used",
"required": false,
"type": "string"
}
},
"desc": "Lists all users in a Slack team.",
"errors": {
"invalid_cursor": "Value passed for `cursor` was not valid or is no longer valid.",
"limit_required": "For large teams a limit is required.",
"missing_argument": "A required argument is missing."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "users:read",
"url": "https://docs.slack.dev/reference/scopes/users.read"
}
],
"user": [
{
"name": "users:read",
"url": "https://docs.slack.dev/reference/scopes/users.read"
}
]
}
}