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

ParameterTypeRequiredDescription
limitintegerNoMembers per page, for example 200. Without it Slack tries to return everyone at once, which fails on large workspaces.
cursorstringNoThe response_metadata.next_cursor of the previous response.
include_localebooleanNotrue 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

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.