arcade-mcp/toolkits/slack_api/arcade_slack_api/wrapper_tools/GetTeamBillableUsersInfo.json
2025-09-23 13:48:21 -03:00

205 lines
6.1 KiB
JSON

{
"name": "GetTeamBillableUsersInfo",
"fully_qualified_name": "SlackApi.GetTeamBillableUsersInfo@0.1.0",
"description": "Retrieves billable users info for the current Slack team.\n\nUse this tool to obtain information about billable users in your Slack team. It requires administrative privileges with the 'admin' scope.",
"toolkit": {
"name": "ArcadeSlackApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "pagination_cursor",
"required": false,
"description": "Cursor for pagination. Use the `next_cursor` from the previous response to fetch the next page of users. (default: 'fetches the first page')",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "cursor"
},
{
"name": "maximum_items_to_return",
"required": false,
"description": "Specifies the maximum number of billable user entries to be retrieved.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "limit"
},
{
"name": "specific_user_id",
"required": false,
"description": "The ID of a specific user to retrieve billable information for. Leave empty to retrieve info for all users.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "user"
},
{
"name": "encoded_team_id",
"required": false,
"description": "Encoded team ID for retrieving billable info, required if using an org token. Ignored with workspace-level tokens.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "team_id"
}
]
},
"output": {
"description": "Response from the API endpoint 'team.billableInfo'.",
"available_modes": [
"value",
"error",
"null"
],
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"requirements": {
"authorization": {
"provider_id": "arcade-slack",
"provider_type": "oauth2",
"id": null,
"oauth2": {
"scopes": [
"admin"
]
}
},
"secrets": null,
"metadata": null
},
"deprecation_message": null,
"metadata": {
"object_type": "api_wrapper_tool",
"version": "1.0.0",
"description": "Arcade Wrapper Tools enabling LLMs to interact with low-level Slack API endpoints."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.0.0",
"description": ""
},
"url": "https://slack.com/api/team.billableInfo",
"http_method": "GET",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
"parameters": [
{
"name": "cursor",
"tool_parameter_name": "pagination_cursor",
"description": "Set `cursor` to `next_cursor` returned by previous call, to indicate from where you want to list next page of users list.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "limit",
"tool_parameter_name": "maximum_items_to_return",
"description": "The maximum number of items to return.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "user",
"tool_parameter_name": "specific_user_id",
"description": "A user to retrieve the billable information for. Defaults to all users.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "team_id",
"tool_parameter_name": "encoded_team_id",
"description": "Encoded team id to get the billable information from, required if org token is used.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
}
],
"documentation_urls": [
"https://docs.slack.dev/reference/methods/team.billableinfo"
],
"secrets": [
{
"arcade_key": "auth_token",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "The OAuth token to use for authentication.",
"is_auth_token": true
}
]
}
}