List users with the Slack API
Lists the members of the workspace with id, name, real_name and profile.email, including bots (is_bot) and deactivated members (deleted). The response has members and response_metadata.next_cursor: pass it as cursor to read the next page.
- Identifier
- slack_list_users
The request
POST https://connect.reportei.com/api/tools/slack_list_users/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"limit": 1
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | No | Members per page, for example 200. Without it Slack tries to return everyone at once, which fails on large workspaces. |
| cursor | string | No | The response_metadata.next_cursor of the previous response. |
| include_locale | boolean | No | true adds the locale of each member. |
Supported connections
Your customer connects their Slack account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/slack, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/slack_list_users. It becomes your agent's tool definition with no conversion.
Other Slack tools
- List conversationsGETLists the channels of the workspace: all public channels and the private channels the app was added to. The id of a channel is the channel argument of the other tools, and is_member tells whether the app is in it. The response has channels and response_metadata.next_cursor: pass it as cursor to read the next page.
- Create conversationPOSTCreates a public or private channel with the app as a member and returns it with its id. Add people to it with Invite members to conversation.
- Join conversationPOSTAdds the app to a public channel and returns the channel. The app must be a member to read the messages of a channel or post in it. A private channel cannot be joined this way: a member adds the app to it in Slack.
- Invite members to conversationPOSTInvites members of the workspace to a channel the app is in. If one of the ids fails, nobody is invited unless force is true.
- List messagesGETLists the messages of a channel the app is a member of, newest first. Thread replies are not included: read them with List thread replies. The response has messages, has_more and response_metadata.next_cursor: pass it as cursor to read the next page. An app installed from outside the Slack Marketplace can be held to 15 messages per call and one call per minute.
- List thread repliesGETLists a thread of a channel the app is a member of: the parent message followed by its replies. The response has messages, has_more and response_metadata.next_cursor: pass it as cursor to read the next page. An app installed from outside the Slack Marketplace can be held to 15 messages per call and one call per minute.
- Send messagePOSTPosts a message as the app's bot and returns it with channel and ts, the pair Update message and Delete message ask for. Send text, markdown_text or blocks. The app must be a member of the channel: call Join conversation first for a public one.
- Schedule messagePOSTSchedules a message from the app's bot for a moment up to 120 days ahead and returns its scheduled_message_id. Send text, markdown_text or blocks. The app must be a member of the channel, and a channel takes at most 30 scheduled messages within the same 5 minutes.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
