Skip to content

Search Slack Workspace Users

GET
/api/v3/organizations/{organisation}/ai/slack-bots/{botId}/workspace/users

Searches users in the Slack workspace connected to this bot. Requires the bot to be connected via OAuth.

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

botId
required
string

The Slack bot ID

Query Parameters

q
string

Search query to filter users by name

Responses

200

Workspace users retrieved successfully

object
results
Array<object>
object
id
string
name
string
real_name
string

403

Access denied

404

Slack bot not found or not connected

500

Failed to search users