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

Chat

create

chat.create Post a chat message to a Storm Risk: write
Input Output

list

chat.list List a Storm’s chat messages Risk: read
Input Output

listUnread

chat.listUnread List a Storm’s unread chat messages Risk: read
Input Output

markAllRead

chat.markAllRead Mark a Storm’s chat messages as read Risk: write
Input Output

Folders

list

folders.list List a team’s folders Risk: read
Input Output: empty object

Ideas

addVote

ideas.addVote Add a vote to an idea Risk: write
Input Output

create

ideas.create Create an idea on a Storm Risk: write
Input Stormboard assigns the id; the answer carries it as {“message”: “idea created”, “id”: 10000001}. color is one of the documented 16 (yellow, the default, through grey) and shape one of standard, gem, hexagon, octagon, square, title or triangle. Output

createComment

ideas.createComment Comment on an idea Risk: write
Input Output

createConnector

ideas.createConnector Draw a line connector between two ideas Risk: write
Input Output

delete

ideas.delete Delete an idea Risk: destructive · Irreversible
Input Output

deleteComment

ideas.deleteComment Delete a comment on an idea Risk: destructive · Irreversible
Input Output

deleteConnector

ideas.deleteConnector Delete a line connector Risk: destructive · Irreversible
Input Output

deleteConnectorBetween

ideas.deleteConnectorBetween Delete the connector between two ideas Risk: destructive · Irreversible
Input The two ids go in the DELETE’s JSON body; the API answers 400 when they come as query parameters. Either idea can be named by its numeric id or its uuid. Output

get

ideas.get Read one idea Risk: read
Input Output

listComments

ideas.listComments List the comments on an idea Risk: read
Input Output

removeVote

ideas.removeVote Remove a vote from an idea Risk: write
Input Output

update

ideas.update Update an idea’s text, position and style Risk: write
Input Output

updateComment

ideas.updateComment Edit a comment on an idea Risk: write
Input Output

updateConnector

ideas.updateConnector Update a line connector’s label and style Risk: write
Input Output

updateTask

ideas.updateTask Update an idea’s task assignment and dates Risk: write
Input Output

Storms

acceptInvite

storms.acceptInvite Accept a Storm invite for the token holder Risk: write
Input Output

close

storms.close Close a Storm; reopening restores it Risk: write
Input Closing answers {“message”: “Storm closed”} and can be undone with api.storms.reopen, so it is registered as a write rather than a delete. Output

create

storms.create Create a Storm Risk: write
Input Output

declineInvite

storms.declineInvite Decline a Storm invite for the token holder Risk: write
Input Output

duplicate

storms.duplicate Duplicate a Storm Risk: write
Input Output

favorite

storms.favorite Star a Storm Risk: write
Input The favorite and unfavorite toggles carry no documented response example, so their output schema accepts any JSON object. Output: empty object

get

storms.get Read one Storm’s details Risk: read
Input Output

getAccess

storms.getAccess Read the token holder’s access to a Storm Risk: read
Input Output

getTemplate

storms.getTemplate Read a Storm’s template sections Risk: read
Input Output

invite

storms.invite Invite participants to a Storm by email; sends mail that cannot be recalled Risk: destructive · Irreversible
Input Output

join

storms.join Join a Storm with its key Risk: write
Input Output

leave

storms.leave Leave a Storm Risk: write
Input Output

list

storms.list List your Storms with search, ordering and paging Risk: read
Input The list read pages with start and results and answers hasmore plus the storms array; walk it by advancing start until hasmore is false. Filters combine: team, folder and needle narrow the result. status is open (the default) or closed; order is activity (the default), alpha, frequency or starred. Output

listConnectors

storms.listConnectors List the line connectors in a Storm Risk: read
Input Output

listIdeas

storms.listIdeas List a Storm’s ideas, optionally filtered by last modified date Risk: read
Input Output

listInvites

storms.listInvites List your Storm invites Risk: read
Input Output

listUsers

storms.listUsers List a Storm’s participants with their activity Risk: read
Input Output

reopen

storms.reopen Re-open a closed Storm Risk: write
Input Output

unfavorite

storms.unfavorite Remove a Storm’s star Risk: write
Input Output: empty object

update

storms.update Update a Storm’s title, description and settings Risk: write
Input Output

updateLegend

storms.updateLegend Set the color labels of a Storm’s legend Risk: write
Input Output

updateSection

storms.updateSection Update one section of a Storm Risk: write
Input Output

Tags

createForIdea

tags.createForIdea Set tag data on an idea Risk: write
Input Output: empty object

createForStorm

tags.createForStorm Create a tag in a Storm Risk: write
Input Output: empty object

getForIdea

tags.getForIdea Read the tag data of an idea Risk: read
Input Output

listForStorm

tags.listForStorm List the tags in a Storm Risk: read
Input Output

Users

create

users.create Create a Stormboard user, which emails them a verification code, and return its API key Risk: destructive
Input Output

getAuth

users.getAuth Read the account API keys with their creation dates Risk: read
Input: empty object Output

getProfile

users.getProfile Read the profile behind the token Risk: read
Input: empty object Output

test

users.test Check that the token authenticates Risk: read
Input: empty object Output

updateNotifications

users.updateNotifications Update the account notification settings Risk: write
Input Output

updateProfile

users.updateProfile Update the profile behind the token Risk: write
Input Output

verify

users.verify Verify a Stormboard account with its verification code Risk: write
Input Output