Admin
conversationsGetTeams
admin.conversationsGetTeams
Get all the workspaces a given channel is connected to
Risk: read
await corsair.slack.api.admin.conversationsGetTeams({});
| Name | Type | Required | Description |
|---|---|---|---|
channel_id | string | Yes | — |
cursor | string | No | — |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
team_ids | string[] | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
conversationsSearch
admin.conversationsSearch
Search for channels on an Enterprise organization
Risk: read
await corsair.slack.api.admin.conversationsSearch({});
| Name | Type | Required | Description |
|---|---|---|---|
team_ids | string[] | No | — |
connected_team_ids | string[] | No | — |
query | string | No | — |
limit | number | No | — |
cursor | string | No | — |
search_channel_types | string[] | No | — |
sort | string | No | — |
sort_dir | string | No | — |
total_count_only | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
conversations | object[] | No | — |
next_cursor | string | No | — |
total_count | number | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
conversations full type
conversations full type
{
id?: string,
name?: string
}[]
conversationsSetTeams
admin.conversationsSetTeams
Set the workspaces in an Enterprise grid org that connect to a channel
Risk: write
await corsair.slack.api.admin.conversationsSetTeams({});
| Name | Type | Required | Description |
|---|---|---|---|
channel_id | string | Yes | — |
team_id | string | No | — |
target_team_ids | string[] | No | — |
org_channel | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
listTeams
admin.listTeams
List all teams on an Enterprise organization
Risk: read
await corsair.slack.api.admin.listTeams({});
| Name | Type | Required | Description |
|---|---|---|---|
limit | number | No | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
teams | object[] | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
teams full type
teams full type
{
id?: string,
name?: string,
discoverability?: string,
primary_owner?: {
user_id?: string,
email?: string
},
team_url?: string
}[]
Channels
archive
channels.archive
Archive a Slack channel
Risk: destructive
await corsair.slack.api.channels.archive({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
close
channels.close
Close a direct message or multi-party DM
Risk: write
await corsair.slack.api.channels.close({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
no_op | boolean | No | — |
already_closed | boolean | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
create
channels.create
Create a new Slack channel
Risk: write
await corsair.slack.api.channels.create({});
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
is_private | boolean | No | — |
team_id | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
channel full type
channel full type
{
id: string,
name?: string,
is_channel?: boolean,
is_group?: boolean,
is_im?: boolean,
is_mpim?: boolean,
is_private?: boolean,
created?: number,
is_archived?: boolean,
is_general?: boolean,
unlinked?: number,
name_normalized?: string,
is_shared?: boolean,
is_org_shared?: boolean,
is_pending_ext_shared?: boolean,
pending_shared?: string[],
context_team_id?: string,
updated?: number,
creator?: string,
is_member?: boolean,
num_members?: number,
topic?: {
value: string,
creator: string,
last_set: number
},
purpose?: {
value: string,
creator: string,
last_set: number
}
}
get
channels.get
Get info about a channel
Risk: read
await corsair.slack.api.channels.get({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
include_locale | boolean | No | — |
include_num_members | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
channel full type
channel full type
{
id: string,
name?: string,
is_channel?: boolean,
is_group?: boolean,
is_im?: boolean,
is_mpim?: boolean,
is_private?: boolean,
created?: number,
is_archived?: boolean,
is_general?: boolean,
unlinked?: number,
name_normalized?: string,
is_shared?: boolean,
is_org_shared?: boolean,
is_pending_ext_shared?: boolean,
pending_shared?: string[],
context_team_id?: string,
updated?: number,
creator?: string,
is_member?: boolean,
num_members?: number,
topic?: {
value: string,
creator: string,
last_set: number
},
purpose?: {
value: string,
creator: string,
last_set: number
}
}
getHistory
channels.getHistory
Fetch message history for a channel
Risk: read
await corsair.slack.api.channels.getHistory({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
latest | string | No | — |
oldest | string | No | — |
inclusive | boolean | No | — |
include_all_metadata | boolean | No | — |
cursor | string | No | — |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
messages | object[] | No | — |
has_more | boolean | No | — |
pin_count | number | No | — |
channel_actions_count | number | No | — |
channel_actions_ts | number | null | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
messages full type
messages full type
{
type?: string,
subtype?: string,
text?: string,
ts?: string,
user?: string,
bot_id?: string,
app_id?: string,
team?: string,
username?: string,
icons?: {
emoji?: string,
image_36?: string,
image_48?: string,
image_72?: string
},
blocks?: {
type: string
}[],
attachments?: Record<string, any>[],
thread_ts?: string,
parent_user_id?: string,
reply_count?: number,
reply_users_count?: number,
latest_reply?: string,
reply_users?: string[],
is_locked?: boolean,
subscribed?: boolean,
reactions?: {
name: string,
count: number,
users: string[]
}[],
edited?: {
user: string,
ts: string
}
}[]
getMembers
channels.getMembers
List members of a channel
Risk: read
await corsair.slack.api.channels.getMembers({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
cursor | string | No | — |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
members | string[] | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
getReplies
channels.getReplies
Fetch replies for a thread
Risk: read
await corsair.slack.api.channels.getReplies({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
ts | string | Yes | — |
latest | string | No | — |
oldest | string | No | — |
inclusive | boolean | No | — |
include_all_metadata | boolean | No | — |
cursor | string | No | — |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
messages | object[] | No | — |
has_more | boolean | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
messages full type
messages full type
{
type?: string,
subtype?: string,
text?: string,
ts?: string,
user?: string,
bot_id?: string,
app_id?: string,
team?: string,
username?: string,
icons?: {
emoji?: string,
image_36?: string,
image_48?: string,
image_72?: string
},
blocks?: {
type: string
}[],
attachments?: Record<string, any>[],
thread_ts?: string,
parent_user_id?: string,
reply_count?: number,
reply_users_count?: number,
latest_reply?: string,
reply_users?: string[],
is_locked?: boolean,
subscribed?: boolean,
reactions?: {
name: string,
count: number,
users: string[]
}[],
edited?: {
user: string,
ts: string
}
}[]
invite
channels.invite
Invite users to a channel
Risk: write
await corsair.slack.api.channels.invite({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
users | string | Yes | — |
force | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
channel full type
channel full type
{
id: string,
name?: string,
is_channel?: boolean,
is_group?: boolean,
is_im?: boolean,
is_mpim?: boolean,
is_private?: boolean,
created?: number,
is_archived?: boolean,
is_general?: boolean,
unlinked?: number,
name_normalized?: string,
is_shared?: boolean,
is_org_shared?: boolean,
is_pending_ext_shared?: boolean,
pending_shared?: string[],
context_team_id?: string,
updated?: number,
creator?: string,
is_member?: boolean,
num_members?: number,
topic?: {
value: string,
creator: string,
last_set: number
},
purpose?: {
value: string,
creator: string,
last_set: number
}
}
join
channels.join
Join a channel
Risk: write
await corsair.slack.api.channels.join({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | object | No | — |
warning | string | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
channel full type
channel full type
{
id: string,
name?: string,
is_channel?: boolean,
is_group?: boolean,
is_im?: boolean,
is_mpim?: boolean,
is_private?: boolean,
created?: number,
is_archived?: boolean,
is_general?: boolean,
unlinked?: number,
name_normalized?: string,
is_shared?: boolean,
is_org_shared?: boolean,
is_pending_ext_shared?: boolean,
pending_shared?: string[],
context_team_id?: string,
updated?: number,
creator?: string,
is_member?: boolean,
num_members?: number,
topic?: {
value: string,
creator: string,
last_set: number
},
purpose?: {
value: string,
creator: string,
last_set: number
}
}
kick
channels.kick
Remove a user from a channel
Risk: write
await corsair.slack.api.channels.kick({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
user | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
leave
channels.leave
Leave a channel
Risk: write
await corsair.slack.api.channels.leave({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
not_in_channel | boolean | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
list
channels.list
List all channels in the workspace
Risk: read
await corsair.slack.api.channels.list({});
| Name | Type | Required | Description |
|---|---|---|---|
exclude_archived | boolean | No | — |
types | string | No | — |
team_id | string | No | — |
cursor | string | No | — |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channels | object[] | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
channels full type
channels full type
{
id: string,
name?: string,
is_channel?: boolean,
is_group?: boolean,
is_im?: boolean,
is_mpim?: boolean,
is_private?: boolean,
created?: number,
is_archived?: boolean,
is_general?: boolean,
unlinked?: number,
name_normalized?: string,
is_shared?: boolean,
is_org_shared?: boolean,
is_pending_ext_shared?: boolean,
pending_shared?: string[],
context_team_id?: string,
updated?: number,
creator?: string,
is_member?: boolean,
num_members?: number,
topic?: {
value: string,
creator: string,
last_set: number
},
purpose?: {
value: string,
creator: string,
last_set: number
}
}[]
open
channels.open
Open a direct message or multi-party DM
Risk: write
await corsair.slack.api.channels.open({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | No | — |
users | string | No | — |
prevent_creation | boolean | No | — |
return_im | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | object | No | — |
no_op | boolean | No | — |
already_open | boolean | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
channel full type
channel full type
{
id: string,
name?: string,
is_channel?: boolean,
is_group?: boolean,
is_im?: boolean,
is_mpim?: boolean,
is_private?: boolean,
created?: number,
is_archived?: boolean,
is_general?: boolean,
unlinked?: number,
name_normalized?: string,
is_shared?: boolean,
is_org_shared?: boolean,
is_pending_ext_shared?: boolean,
pending_shared?: string[],
context_team_id?: string,
updated?: number,
creator?: string,
is_member?: boolean,
num_members?: number,
topic?: {
value: string,
creator: string,
last_set: number
},
purpose?: {
value: string,
creator: string,
last_set: number
}
}
rename
channels.rename
Rename a channel
Risk: write
await corsair.slack.api.channels.rename({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
name | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
channel full type
channel full type
{
id: string,
name?: string,
is_channel?: boolean,
is_group?: boolean,
is_im?: boolean,
is_mpim?: boolean,
is_private?: boolean,
created?: number,
is_archived?: boolean,
is_general?: boolean,
unlinked?: number,
name_normalized?: string,
is_shared?: boolean,
is_org_shared?: boolean,
is_pending_ext_shared?: boolean,
pending_shared?: string[],
context_team_id?: string,
updated?: number,
creator?: string,
is_member?: boolean,
num_members?: number,
topic?: {
value: string,
creator: string,
last_set: number
},
purpose?: {
value: string,
creator: string,
last_set: number
}
}
setPurpose
channels.setPurpose
Set the purpose of a channel
Risk: write
await corsair.slack.api.channels.setPurpose({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
purpose | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | object | No | — |
purpose | string | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
channel full type
channel full type
{
id: string,
name?: string,
is_channel?: boolean,
is_group?: boolean,
is_im?: boolean,
is_mpim?: boolean,
is_private?: boolean,
created?: number,
is_archived?: boolean,
is_general?: boolean,
unlinked?: number,
name_normalized?: string,
is_shared?: boolean,
is_org_shared?: boolean,
is_pending_ext_shared?: boolean,
pending_shared?: string[],
context_team_id?: string,
updated?: number,
creator?: string,
is_member?: boolean,
num_members?: number,
topic?: {
value: string,
creator: string,
last_set: number
},
purpose?: {
value: string,
creator: string,
last_set: number
}
}
setTopic
channels.setTopic
Set the topic of a channel
Risk: write
await corsair.slack.api.channels.setTopic({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
topic | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | object | No | — |
topic | string | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
channel full type
channel full type
{
id: string,
name?: string,
is_channel?: boolean,
is_group?: boolean,
is_im?: boolean,
is_mpim?: boolean,
is_private?: boolean,
created?: number,
is_archived?: boolean,
is_general?: boolean,
unlinked?: number,
name_normalized?: string,
is_shared?: boolean,
is_org_shared?: boolean,
is_pending_ext_shared?: boolean,
pending_shared?: string[],
context_team_id?: string,
updated?: number,
creator?: string,
is_member?: boolean,
num_members?: number,
topic?: {
value: string,
creator: string,
last_set: number
},
purpose?: {
value: string,
creator: string,
last_set: number
}
}
unarchive
channels.unarchive
Unarchive a channel
Risk: write
await corsair.slack.api.channels.unarchive({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
Files
get
files.get
Get info about a file
Risk: read
await corsair.slack.api.files.get({});
| Name | Type | Required | Description |
|---|---|---|---|
file | string | Yes | — |
cursor | string | No | — |
limit | number | No | — |
page | number | No | — |
count | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
file | object | No | — |
comments | object[] | No | — |
paging | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
file full type
file full type
{
id: string,
created?: number,
timestamp?: number,
name?: string,
title?: string,
mimetype?: string,
filetype?: string,
pretty_type?: string,
user?: string,
user_team?: string,
editable?: boolean,
size?: number,
mode?: string,
is_external?: boolean,
external_type?: string,
is_public?: boolean,
public_url_shared?: boolean,
display_as_bot?: boolean,
username?: string,
url_private?: string,
url_private_download?: string,
permalink?: string,
permalink_public?: string,
channels?: string[],
groups?: string[],
ims?: string[]
}
comments full type
comments full type
paging full type
paging full type
{
count: number,
total: number,
page: number,
pages: number
}
list
files.list
List files in the workspace
Risk: read
await corsair.slack.api.files.list({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | No | — |
user | string | No | — |
types | string | No | — |
ts_from | string | No | — |
ts_to | string | No | — |
show_files_hidden_by_limit | boolean | No | — |
team_id | string | No | — |
page | number | No | — |
count | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
files | object[] | No | — |
paging | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
files full type
files full type
{
id: string,
created?: number,
timestamp?: number,
name?: string,
title?: string,
mimetype?: string,
filetype?: string,
pretty_type?: string,
user?: string,
user_team?: string,
editable?: boolean,
size?: number,
mode?: string,
is_external?: boolean,
external_type?: string,
is_public?: boolean,
public_url_shared?: boolean,
display_as_bot?: boolean,
username?: string,
url_private?: string,
url_private_download?: string,
permalink?: string,
permalink_public?: string,
channels?: string[],
groups?: string[],
ims?: string[]
}[]
paging full type
paging full type
{
count: number,
total: number,
page: number,
pages: number
}
upload
files.upload
Upload a file to Slack
Risk: write
await corsair.slack.api.files.upload({});
| Name | Type | Required | Description |
|---|---|---|---|
channels | string | No | — |
content | string | No | — |
file | any | No | — |
filename | string | No | — |
filetype | string | No | — |
initial_comment | string | No | — |
thread_ts | string | No | — |
title | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
file | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
file full type
file full type
{
id: string,
created?: number,
timestamp?: number,
name?: string,
title?: string,
mimetype?: string,
filetype?: string,
pretty_type?: string,
user?: string,
user_team?: string,
editable?: boolean,
size?: number,
mode?: string,
is_external?: boolean,
external_type?: string,
is_public?: boolean,
public_url_shared?: boolean,
display_as_bot?: boolean,
username?: string,
url_private?: string,
url_private_download?: string,
permalink?: string,
permalink_public?: string,
channels?: string[],
groups?: string[],
ims?: string[]
}
Messages
delete
messages.delete
Delete a message
Risk: destructive
await corsair.slack.api.messages.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
ts | string | Yes | — |
as_user | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | string | No | — |
ts | string | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
getPermalink
messages.getPermalink
Get a permalink for a message
Risk: read
await corsair.slack.api.messages.getPermalink({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
message_ts | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | string | No | — |
permalink | string | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
post
messages.post
Post a message to a channel
Risk: write
await corsair.slack.api.messages.post({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
text | string | No | — |
blocks | object[] | No | — |
attachments | Record<string, any>[] | No | — |
thread_ts | string | No | — |
reply_broadcast | boolean | No | — |
parse | full | none | No | — |
link_names | boolean | No | — |
unfurl_links | boolean | No | — |
unfurl_media | boolean | No | — |
mrkdwn | boolean | No | — |
as_user | boolean | No | — |
icon_emoji | string | No | — |
icon_url | string | No | — |
username | string | No | — |
metadata | object | No | — |
blocks full type
blocks full type
{
type: string
}[]
metadata full type
metadata full type
{
event_type: string,
event_payload: Record<string, any>
}
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | string | No | — |
ts | string | No | — |
message | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
message full type
message full type
{
type?: string,
subtype?: string,
text?: string,
ts?: string,
user?: string,
bot_id?: string,
app_id?: string,
team?: string,
username?: string,
icons?: {
emoji?: string,
image_36?: string,
image_48?: string,
image_72?: string
},
blocks?: {
type: string
}[],
attachments?: Record<string, any>[],
thread_ts?: string,
parent_user_id?: string,
reply_count?: number,
reply_users_count?: number,
latest_reply?: string,
reply_users?: string[],
is_locked?: boolean,
subscribed?: boolean,
reactions?: {
name: string,
count: number,
users: string[]
}[],
edited?: {
user: string,
ts: string
}
}
search
messages.search
Search messages in the workspace
Risk: read
await corsair.slack.api.messages.search({});
| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | — |
sort | score | timestamp | No | — |
sort_dir | asc | desc | No | — |
highlight | boolean | No | — |
team_id | string | No | — |
cursor | string | No | — |
limit | number | No | — |
page | number | No | — |
count | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
query | string | No | — |
messages | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
messages full type
messages full type
{
total?: number,
pagination?: {
total_count?: number,
page?: number,
per_page?: number,
page_count?: number,
first?: number,
last?: number
},
paging?: {
count: number,
total: number,
page: number,
pages: number
},
matches?: {
type?: string,
subtype?: string,
text?: string,
ts?: string,
user?: string,
bot_id?: string,
app_id?: string,
team?: string,
username?: string,
icons?: {
emoji?: string,
image_36?: string,
image_48?: string,
image_72?: string
},
blocks?: {
type: string
}[],
attachments?: Record<string, any>[],
thread_ts?: string,
parent_user_id?: string,
reply_count?: number,
reply_users_count?: number,
latest_reply?: string,
reply_users?: string[],
is_locked?: boolean,
subscribed?: boolean,
reactions?: {
name: string,
count: number,
users: string[]
}[],
edited?: {
user: string,
ts: string
},
channel?: {
id: string,
name?: string
},
permalink?: string
}[]
}
update
messages.update
Update an existing message
Risk: write
await corsair.slack.api.messages.update({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
ts | string | Yes | — |
text | string | No | — |
blocks | object[] | No | — |
attachments | Record<string, any>[] | No | — |
parse | full | none | No | — |
link_names | boolean | No | — |
as_user | boolean | No | — |
file_ids | string[] | No | — |
reply_broadcast | boolean | No | — |
metadata | object | No | — |
blocks full type
blocks full type
{
type: string
}[]
metadata full type
metadata full type
{
event_type: string,
event_payload: Record<string, any>
}
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
channel | string | No | — |
ts | string | No | — |
text | string | No | — |
message | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
message full type
message full type
{
type?: string,
subtype?: string,
text?: string,
ts?: string,
user?: string,
bot_id?: string,
app_id?: string,
team?: string,
username?: string,
icons?: {
emoji?: string,
image_36?: string,
image_48?: string,
image_72?: string
},
blocks?: {
type: string
}[],
attachments?: Record<string, any>[],
thread_ts?: string,
parent_user_id?: string,
reply_count?: number,
reply_users_count?: number,
latest_reply?: string,
reply_users?: string[],
is_locked?: boolean,
subscribed?: boolean,
reactions?: {
name: string,
count: number,
users: string[]
}[],
edited?: {
user: string,
ts: string
}
}
Reactions
add
reactions.add
Add a reaction emoji to a message
Risk: write
await corsair.slack.api.reactions.add({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | — |
timestamp | string | Yes | — |
name | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
get
reactions.get
Get reactions for a message
Risk: read
await corsair.slack.api.reactions.get({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | No | — |
timestamp | string | No | — |
file | string | No | — |
file_comment | string | No | — |
full | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
type | string | No | — |
channel | string | No | — |
message | object | No | — |
file | object | No | — |
comment | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
message full type
message full type
{
type?: string,
subtype?: string,
text?: string,
ts?: string,
user?: string,
bot_id?: string,
app_id?: string,
team?: string,
username?: string,
icons?: {
emoji?: string,
image_36?: string,
image_48?: string,
image_72?: string
},
blocks?: {
type: string
}[],
attachments?: Record<string, any>[],
thread_ts?: string,
parent_user_id?: string,
reply_count?: number,
reply_users_count?: number,
latest_reply?: string,
reply_users?: string[],
is_locked?: boolean,
subscribed?: boolean,
reactions?: {
name: string,
count: number,
users: string[]
}[],
edited?: {
user: string,
ts: string
}
}
file full type
file full type
{
id: string,
created?: number,
timestamp?: number,
name?: string,
title?: string,
mimetype?: string,
filetype?: string,
pretty_type?: string,
user?: string,
user_team?: string,
editable?: boolean,
size?: number,
mode?: string,
is_external?: boolean,
external_type?: string,
is_public?: boolean,
public_url_shared?: boolean,
display_as_bot?: boolean,
username?: string,
url_private?: string,
url_private_download?: string,
permalink?: string,
permalink_public?: string,
channels?: string[],
groups?: string[],
ims?: string[]
}
comment full type
comment full type
{
id: string,
comment: string,
reactions?: {
name: string,
count: number,
users: string[]
}[]
}
remove
reactions.remove
Remove a reaction emoji from a message
Risk: write
await corsair.slack.api.reactions.remove({});
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
channel | string | No | — |
timestamp | string | No | — |
file | string | No | — |
file_comment | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
Stars
add
stars.add
Star an item
Risk: write
await corsair.slack.api.stars.add({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | No | — |
timestamp | string | No | — |
file | string | No | — |
file_comment | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
list
stars.list
List starred items for the authenticated user
Risk: read
await corsair.slack.api.stars.list({});
| Name | Type | Required | Description |
|---|---|---|---|
team_id | string | No | — |
cursor | string | No | — |
limit | number | No | — |
page | number | No | — |
count | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
items | object[] | No | — |
paging | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
items full type
items full type
{
type: string,
channel?: string,
message?: {
type?: string,
subtype?: string,
text?: string,
ts?: string,
user?: string,
bot_id?: string,
app_id?: string,
team?: string,
username?: string,
icons?: {
emoji?: string,
image_36?: string,
image_48?: string,
image_72?: string
},
blocks?: {
type: string
}[],
attachments?: Record<string, any>[],
thread_ts?: string,
parent_user_id?: string,
reply_count?: number,
reply_users_count?: number,
latest_reply?: string,
reply_users?: string[],
is_locked?: boolean,
subscribed?: boolean,
reactions?: {
name: string,
count: number,
users: string[]
}[],
edited?: {
user: string,
ts: string
}
},
file?: {
id: string,
created?: number,
timestamp?: number,
name?: string,
title?: string,
mimetype?: string,
filetype?: string,
pretty_type?: string,
user?: string,
user_team?: string,
editable?: boolean,
size?: number,
mode?: string,
is_external?: boolean,
external_type?: string,
is_public?: boolean,
public_url_shared?: boolean,
display_as_bot?: boolean,
username?: string,
url_private?: string,
url_private_download?: string,
permalink?: string,
permalink_public?: string,
channels?: string[],
groups?: string[],
ims?: string[]
},
comment?: {
id: string,
comment: string
},
date_create?: number
}[]
paging full type
paging full type
{
count: number,
total: number,
page: number,
pages: number
}
remove
stars.remove
Unstar an item
Risk: write
await corsair.slack.api.stars.remove({});
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | No | — |
timestamp | string | No | — |
file | string | No | — |
file_comment | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
User Groups
create
userGroups.create
Create a user group
Risk: write
await corsair.slack.api.userGroups.create({});
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
channels | string | No | — |
description | string | No | — |
handle | string | No | — |
include_count | boolean | No | — |
team_id | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
usergroup | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
usergroup full type
usergroup full type
{
id: string,
team_id?: string,
is_usergroup?: boolean,
is_subteam?: boolean,
name?: string,
description?: string,
handle?: string,
is_external?: boolean,
date_create?: number,
date_update?: number,
date_delete?: number,
auto_type?: string | null,
auto_provision?: boolean,
enterprise_subteam_id?: string,
created_by?: string,
updated_by?: string,
deleted_by?: string | null,
prefs?: {
channels?: string[],
groups?: string[]
},
users?: string[],
user_count?: number,
channel_count?: number
}
disable
userGroups.disable
Disable a user group
Risk: write
await corsair.slack.api.userGroups.disable({});
| Name | Type | Required | Description |
|---|---|---|---|
userGroup | string | Yes | — |
include_count | boolean | No | — |
team_id | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
usergroup | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
usergroup full type
usergroup full type
{
id: string,
team_id?: string,
is_usergroup?: boolean,
is_subteam?: boolean,
name?: string,
description?: string,
handle?: string,
is_external?: boolean,
date_create?: number,
date_update?: number,
date_delete?: number,
auto_type?: string | null,
auto_provision?: boolean,
enterprise_subteam_id?: string,
created_by?: string,
updated_by?: string,
deleted_by?: string | null,
prefs?: {
channels?: string[],
groups?: string[]
},
users?: string[],
user_count?: number,
channel_count?: number
}
enable
userGroups.enable
Enable a user group
Risk: write
await corsair.slack.api.userGroups.enable({});
| Name | Type | Required | Description |
|---|---|---|---|
userGroup | string | Yes | — |
include_count | boolean | No | — |
team_id | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
usergroup | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
usergroup full type
usergroup full type
{
id: string,
team_id?: string,
is_usergroup?: boolean,
is_subteam?: boolean,
name?: string,
description?: string,
handle?: string,
is_external?: boolean,
date_create?: number,
date_update?: number,
date_delete?: number,
auto_type?: string | null,
auto_provision?: boolean,
enterprise_subteam_id?: string,
created_by?: string,
updated_by?: string,
deleted_by?: string | null,
prefs?: {
channels?: string[],
groups?: string[]
},
users?: string[],
user_count?: number,
channel_count?: number
}
list
userGroups.list
List user groups in the workspace
Risk: read
await corsair.slack.api.userGroups.list({});
| Name | Type | Required | Description |
|---|---|---|---|
include_count | boolean | No | — |
include_disabled | boolean | No | — |
include_users | boolean | No | — |
team_id | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
userGroups | object[] | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
userGroups full type
userGroups full type
{
id: string,
team_id?: string,
is_usergroup?: boolean,
is_subteam?: boolean,
name?: string,
description?: string,
handle?: string,
is_external?: boolean,
date_create?: number,
date_update?: number,
date_delete?: number,
auto_type?: string | null,
auto_provision?: boolean,
enterprise_subteam_id?: string,
created_by?: string,
updated_by?: string,
deleted_by?: string | null,
prefs?: {
channels?: string[],
groups?: string[]
},
users?: string[],
user_count?: number,
channel_count?: number
}[]
update
userGroups.update
Update a user group
Risk: write
await corsair.slack.api.userGroups.update({});
| Name | Type | Required | Description |
|---|---|---|---|
userGroup | string | Yes | — |
name | string | No | — |
channels | string | No | — |
description | string | No | — |
handle | string | No | — |
include_count | boolean | No | — |
team_id | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
usergroup | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
usergroup full type
usergroup full type
{
id: string,
team_id?: string,
is_usergroup?: boolean,
is_subteam?: boolean,
name?: string,
description?: string,
handle?: string,
is_external?: boolean,
date_create?: number,
date_update?: number,
date_delete?: number,
auto_type?: string | null,
auto_provision?: boolean,
enterprise_subteam_id?: string,
created_by?: string,
updated_by?: string,
deleted_by?: string | null,
prefs?: {
channels?: string[],
groups?: string[]
},
users?: string[],
user_count?: number,
channel_count?: number
}
Users
get
users.get
Get info about a user
Risk: read
await corsair.slack.api.users.get({});
| Name | Type | Required | Description |
|---|---|---|---|
user | string | Yes | — |
include_locale | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
user | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
user full type
user full type
{
id: string,
team_id?: string,
name?: string,
deleted?: boolean,
color?: string,
real_name?: string,
tz?: string,
tz_label?: string,
tz_offset?: number,
profile?: {
avatar_hash?: string,
status_text?: string,
status_emoji?: string,
status_expiration?: number,
real_name?: string,
display_name?: string,
real_name_normalized?: string,
display_name_normalized?: string,
email?: string,
image_24?: string,
image_32?: string,
image_48?: string,
image_72?: string,
image_192?: string,
image_512?: string,
team?: string,
title?: string,
phone?: string,
skype?: string,
first_name?: string,
last_name?: string
},
is_admin?: boolean,
is_owner?: boolean,
is_primary_owner?: boolean,
is_restricted?: boolean,
is_ultra_restricted?: boolean,
is_bot?: boolean,
is_app_user?: boolean,
updated?: number,
is_email_confirmed?: boolean,
who_can_share_contact_card?: string,
locale?: string
}
getPresence
users.getPresence
Get the presence status of a user
Risk: read
await corsair.slack.api.users.getPresence({});
| Name | Type | Required | Description |
|---|---|---|---|
user | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
presence | string | No | — |
online | boolean | No | — |
auto_away | boolean | No | — |
manual_away | boolean | No | — |
connection_count | number | No | — |
last_activity | number | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
getProfile
users.getProfile
Get a user profile
Risk: read
await corsair.slack.api.users.getProfile({});
| Name | Type | Required | Description |
|---|---|---|---|
user | string | No | — |
include_labels | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
profile | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
profile full type
profile full type
{
avatar_hash?: string,
status_text?: string,
status_emoji?: string,
status_expiration?: number,
real_name?: string,
display_name?: string,
real_name_normalized?: string,
display_name_normalized?: string,
email?: string,
image_24?: string,
image_32?: string,
image_48?: string,
image_72?: string,
image_192?: string,
image_512?: string,
team?: string,
title?: string,
phone?: string,
skype?: string,
first_name?: string,
last_name?: string
}
list
users.list
List all users in the workspace
Risk: read
await corsair.slack.api.users.list({});
| Name | Type | Required | Description |
|---|---|---|---|
include_locale | boolean | No | — |
team_id | string | No | — |
cursor | string | No | — |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
members | object[] | No | — |
cache_ts | number | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
members full type
members full type
{
id: string,
team_id?: string,
name?: string,
deleted?: boolean,
color?: string,
real_name?: string,
tz?: string,
tz_label?: string,
tz_offset?: number,
profile?: {
avatar_hash?: string,
status_text?: string,
status_emoji?: string,
status_expiration?: number,
real_name?: string,
display_name?: string,
real_name_normalized?: string,
display_name_normalized?: string,
email?: string,
image_24?: string,
image_32?: string,
image_48?: string,
image_72?: string,
image_192?: string,
image_512?: string,
team?: string,
title?: string,
phone?: string,
skype?: string,
first_name?: string,
last_name?: string
},
is_admin?: boolean,
is_owner?: boolean,
is_primary_owner?: boolean,
is_restricted?: boolean,
is_ultra_restricted?: boolean,
is_bot?: boolean,
is_app_user?: boolean,
updated?: number,
is_email_confirmed?: boolean,
who_can_share_contact_card?: string,
locale?: string
}[]
updateProfile
users.updateProfile
Update the authenticated user’s profile
Risk: write
await corsair.slack.api.users.updateProfile({});
| Name | Type | Required | Description |
|---|---|---|---|
profile | Record<string, any> | No | — |
user | string | No | — |
name | string | No | — |
value | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
error | string | No | — |
needed | string | No | — |
provided | string | No | — |
response_metadata | object | No | — |
profile | object | No | — |
response_metadata full type
response_metadata full type
{
next_cursor?: string,
messages?: string[]
}
profile full type
profile full type
{
avatar_hash?: string,
status_text?: string,
status_emoji?: string,
status_expiration?: number,
real_name?: string,
display_name?: string,
real_name_normalized?: string,
display_name_normalized?: string,
email?: string,
image_24?: string,
image_32?: string,
image_48?: string,
image_72?: string,
image_192?: string,
image_512?: string,
team?: string,
title?: string,
phone?: string,
skype?: string,
first_name?: string,
last_name?: string
}