UNPKG

@microfox/slack

Version:

This package provides a lightweight, proxy interface to the official Slack Web API, offering a curated set of the most commonly used functions for building Slack integrations. It is designed to be simple, efficient, and easy to integrate into your project

122 lines (121 loc) 4.01 kB
{ "post": { "operationId": "getActiveUsersIds", "summary": "Retrieves a map of user IDs to user names and emails.", "description": "Returns an array of objects, each containing the ID, name, real name, display name, title, and email of an active users in the workspace.", "tags": [ "user" ], "ai": { "systemPrompt": "This function lists all active users in the workspace and returns a map of their IDs, names, and emails. ALWAYS use this when you need to find a userId by their name or email. If needed, paginate until the userId is found using nextCursor in the response of the last try", "disableTool": true }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "object", "description": "Body of the getActiveUsersIds sls call", "properties": { "arguments": { "type": "object", "properties": { "includeBots": { "type": "boolean", "description": "Whether to include bot users in the list. Defaults to false." }, "cursor": { "type": "string", "description": "A cursor to the next page of results." }, "limit": { "type": "number", "description": "The maximum number of users to return." } } } }, "required": [ "arguments" ] } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the user." }, "name": { "type": "string", "description": "The name of the user." }, "real_name": { "type": "string", "description": "The real name of the user." }, "display_name": { "type": "string", "description": "The display name of the user." }, "title": { "type": "string", "description": "The title of the user." }, "email": { "type": "string", "description": "The email of the user." } }, "required": [ "id", "name" ] } }, "nextCursor": { "type": "string", "description": "A cursor to the next page of results" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } } } } }