Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

get

account.get Get profile information of the authenticated user Risk: read
Input: empty object Output

getStatus

account.getStatus Get unread, mention and open task counts for the authenticated user Risk: read
Input: empty object Output

listTasks

account.listTasks List tasks assigned to the authenticated user (up to 100) Risk: read
Input Output: object[]

Contacts

list

contacts.list List contacts of the authenticated user Risk: read
Input: empty object Output: object[]

listIncomingRequests

contacts.listIncomingRequests List pending contact requests sent to the authenticated user (up to 100) Risk: read
Input: empty object Output: object[]

Files

get

files.get Get file details, optionally with a temporary download URL Risk: read
Input Output

list

files.list List files uploaded to a chat room (up to 100) Risk: read
Input Output: object[]

upload

files.upload Upload a file to a chat room Risk: write
Input Output

create

links.create Create an invitation link for a group chat Risk: write
Input Output

delete

links.delete Delete the invitation link of a group chat Risk: destructive · Irreversible
Input Output

get

links.get Get the invitation link of a group chat Risk: read
Input Output

update

links.update Update the invitation link of a group chat Risk: write
Input Output

Members

list

members.list List members belonging to a chat room Risk: read
Input Output: object[]

update

members.update Replace the member list and roles of a group chat Risk: write
Input Output

Messages

delete

messages.delete Delete a message from a chat room Risk: destructive · Irreversible
Input Output

get

messages.get Get a specific message from a chat room Risk: read
Input Output

list

messages.list List messages in a chat room (up to 100) Risk: read
Input Output: object[]

markRead

messages.markRead Mark messages in a chat room as read Risk: write
Input Output

markUnread

messages.markUnread Mark messages in a chat room as unread from a given message Risk: write
Input Output

send

messages.send Send a new message to a chat room Risk: write
Input Output

update

messages.update Edit the body of a message Risk: write
Input Output

Rooms

create

rooms.create Create a new group chat Risk: write
Input Output

delete

rooms.delete Leave or permanently delete a group chat Risk: destructive · Irreversible
Input Output

get

rooms.get Get details of a specific chat room Risk: read
Input Output

list

rooms.list List chat rooms the authenticated user belongs to Risk: read
Input: empty object Output: object[]

update

rooms.update Update the name, description or icon of a group chat Risk: write
Input Output

Tasks

create

tasks.create Create a task in a chat room Risk: write
Input Output

get

tasks.get Get a specific task in a chat room Risk: read
Input Output

list

tasks.list List tasks in a chat room (up to 100) Risk: read
Input Output: object[]

updateStatus

tasks.updateStatus Mark a task as done or reopen it Risk: write
Input Output