slack.listusersprops
Home > @runlightyear/slack > ListUsersProps
ListUsersProps interface
Signature:interface ListUsersProps
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| cursor? | string | 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. | |
| includeLocale? | boolean | Set this to true to receive the locale for users. Defaults to false | |
| limit? | number | 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. | |
| teamId? | string | encoded team id to list users in, required if org token is used |