> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Stormboard API reference

> API reference for the Stormboard plugin in Corsair: every `stormboard.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Chat

### create

`chat.create`

Post a chat message to a Storm

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.chat.create({ stormId: 1234, message: 'Example Chat Message 1' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |
| `message` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `object` | Yes | — |

> [accordion] message full type
>
> ```ts theme={null}
> {
>   isnew?: boolean | null,
>   storm?: number | string | null,
>   user?: {
>     id?: number | string | null,
>     name?: string | null
>   } | null,
>   created?: string | null,
>   msg?: string | null
> }
> ```

***

### list

`chat.list`

List a Storm's chat messages

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.chat.list({ stormId: 1234 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `messages` | `object[]` | Yes | — |

> [accordion] messages full type
>
> ```ts theme={null}
> {
>   isnew?: boolean | null,
>   storm?: number | string | null,
>   user?: {
>     id?: number | string | null,
>     name?: string | null
>   } | null,
>   created?: string | null,
>   msg?: string | null
> }[]
> ```

***

### listUnread

`chat.listUnread`

List a Storm's unread chat messages

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.chat.listUnread({ stormId: 1234 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `messages` | `object[]` | Yes | — |

> [accordion] messages full type
>
> ```ts theme={null}
> {
>   isnew?: boolean | null,
>   storm?: number | string | null,
>   user?: {
>     id?: number | string | null,
>     name?: string | null
>   } | null,
>   created?: string | null,
>   msg?: string | null
> }[]
> ```

***

### markAllRead

`chat.markAllRead`

Mark a Storm's chat messages as read

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.chat.markAllRead({ stormId: 1234 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `number \| string` | Yes | — |

***

## Folders

### list

`folders.list`

List a team's folders

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.folders.list({ teamId: 1 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `teamId` | `number` | Yes | — |

**Output:** *empty object*

***

## Ideas

### addVote

`ideas.addVote`

Add a vote to an idea

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.ideas.addVote({ ideaId: 1000000 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |
| `idea` | `object \| null` | No | — |
| `storm` | `object \| null` | No | — |

> [accordion] idea full type
>
> ```ts theme={null}
> {
>   totalvotes?: number | null,
>   myvotes?: number | string | null
> } | null
> ```

> [accordion] storm full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   title?: string | null,
>   votesremaining?: number | null
> } | null
> ```

***

### create

`ideas.create`

Create an idea on a Storm

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.ideas.create({ stormid: 49999, data: 'This is an idea. Like it?' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormid` | `number` | Yes | — |
| `type` | `string` | No | — |
| `data` | `string` | Yes | — |
| `name` | `string` | No | — |
| `color` | `yellow \| light-orange \| orange \| red \| light-green \| green \| teal \| turquoise \| light-blue \| blue \| light-purple \| purple \| brown \| light-pink \| pink \| grey` | No | — |
| `shape` | `standard \| gem \| hexagon \| octagon \| square \| title \| triangle` | No | — |
| `sectionindex` | `string` | No | — |
| `x` | `number` | No | — |
| `y` | `number` | No | — |
| `lock` | `0 \| 1` | No | — |

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**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### createComment

`ideas.createComment`

Comment on an idea

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.ideas.createComment({ ideaId: 1000000, comment: 'My awesome comment' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |
| `comment` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `comment` | `object \| null` | No | — |

> [accordion] comment full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   comment?: string | null,
>   created?: string | null,
>   user?: {
>     id?: number | string | null,
>     name?: string | null
>   } | null
> } | null
> ```

***

### createConnector

`ideas.createConnector`

Draw a line connector between two ideas

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.ideas.createConnector({ from_idea_id: 1000, to_idea_id: 1001, label: 'Depends On' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `from_idea_id` | `number \| string` | Yes | The idea's numeric id or its uuid. |
| `to_idea_id` | `number \| string` | Yes | The idea's numeric id or its uuid. |
| `label` | `string` | No | — |
| `color` | `string` | No | — |
| `to_end_type` | `string` | No | — |
| `from_end_type` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| null` | No | — |
| `connector` | `object` | Yes | — |

> [accordion] connector full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   from?: number | string | null,
>   to?: number | string | null,
>   from_uuid?: string | null,
>   to_uuid?: string | null,
>   label?: string | null,
>   style?: {
>     color?: string | null,
>     fromEndType?: string | null,
>     toEndType?: string | null
>   } | null,
>   points?: any[] | null
> }
> ```

***

### delete

`ideas.delete`

Delete an idea

**Risk:** `destructive` · **Irreversible**

```ts theme={null}
await corsair.stormboard.api.ideas.delete({ ideaId: 1000000 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### deleteComment

`ideas.deleteComment`

Delete a comment on an idea

**Risk:** `destructive` · **Irreversible**

```ts theme={null}
await corsair.stormboard.api.ideas.deleteComment({ ideaId: 1000000, commentId: 1234 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |
| `commentId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### deleteConnector

`ideas.deleteConnector`

Delete a line connector

**Risk:** `destructive` · **Irreversible**

```ts theme={null}
await corsair.stormboard.api.ideas.deleteConnector({ connectorId: 9999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `connectorId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### deleteConnectorBetween

`ideas.deleteConnectorBetween`

Delete the connector between two ideas

**Risk:** `destructive` · **Irreversible**

```ts theme={null}
await corsair.stormboard.api.ideas.deleteConnectorBetween({ from_idea_id: 1000, to_idea_id: 1001 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `from_idea_id` | `number \| string` | Yes | The idea's numeric id or its uuid. |
| `to_idea_id` | `number \| string` | Yes | The idea's numeric id or its uuid. |

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**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### get

`ideas.get`

Read one idea

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.ideas.get({ ideaId: 1000000 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `idea` | `object` | Yes | — |

> [accordion] idea full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   uuid?: string | null,
>   storm?: {
>     id?: number | string | null,
>     title?: string | null
>   } | null,
>   x?: number | null,
>   y?: number | null,
>   z?: number | null,
>   color?: string | null,
>   lock?: number | null,
>   comments?: number | null,
>   votes?: number | null,
>   type?: string | null,
>   data?: {
>     text?: string | null,
>     name?: string | null
>   } | null,
>   task?: Record<string, any> | null
> }
> ```

***

### listComments

`ideas.listComments`

List the comments on an idea

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.ideas.listComments({ ideaId: 1000000, order: "asc" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |
| `order` | `asc \| desc` | No | — |
| `avatars` | `0 \| 1` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `comments` | `object[]` | Yes | — |

> [accordion] comments full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   comment?: string | null,
>   created?: string | null,
>   user?: {
>     id?: number | string | null,
>     name?: string | null
>   } | null
> }[]
> ```

***

### removeVote

`ideas.removeVote`

Remove a vote from an idea

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.ideas.removeVote({ ideaId: 1000000 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |
| `idea` | `object \| null` | No | — |
| `storm` | `object \| null` | No | — |

> [accordion] idea full type
>
> ```ts theme={null}
> {
>   totalvotes?: number | null,
>   myvotes?: number | string | null
> } | null
> ```

> [accordion] storm full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   title?: string | null,
>   votesremaining?: number | null
> } | null
> ```

***

### update

`ideas.update`

Update an idea's text, position and style

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.ideas.update({ ideaId: 10000001, data: 'Updated idea text' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |
| `type` | `string` | No | — |
| `data` | `string` | Yes | — |
| `color` | `yellow \| light-orange \| orange \| red \| light-green \| green \| teal \| turquoise \| light-blue \| blue \| light-purple \| purple \| brown \| light-pink \| pink \| grey` | No | — |
| `shape` | `standard \| gem \| hexagon \| octagon \| square \| title \| triangle` | No | — |
| `x` | `number` | No | — |
| `y` | `number` | No | — |
| `lock` | `0 \| 1` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### updateComment

`ideas.updateComment`

Edit a comment on an idea

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.ideas.updateComment({ ideaId: 1000000, commentId: 1234, comment: 'Edited comment' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |
| `commentId` | `number` | Yes | — |
| `comment` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### updateConnector

`ideas.updateConnector`

Update a line connector's label and style

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.ideas.updateConnector({ connectorId: 9999, label: 'Depended On' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `connectorId` | `number` | Yes | — |
| `label` | `string` | No | — |
| `color` | `string` | No | — |
| `to_end_type` | `string` | No | — |
| `from_end_type` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| null` | No | — |
| `connector` | `object` | Yes | — |

> [accordion] connector full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   from?: number | string | null,
>   to?: number | string | null,
>   from_uuid?: string | null,
>   to_uuid?: string | null,
>   label?: string | null,
>   style?: {
>     color?: string | null,
>     fromEndType?: string | null,
>     toEndType?: string | null
>   } | null,
>   points?: any[] | null
> }
> ```

***

### updateTask

`ideas.updateTask`

Update an idea's task assignment and dates

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.ideas.updateTask({ ideaId: 1000000, assigned_to: 1, date_due: '2020-01-01' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |
| `assigned_to` | `number` | No | — |
| `date_due` | `string` | No | An ISO 8601 date; dates without a timezone are read as UTC. |
| `date_completed` | `string` | No | An ISO 8601 date; dates without a timezone are read as UTC. |
| `notify` | `0 \| 1` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `task` | `object` | Yes | — |

> [accordion] task full type
>
> ```ts theme={null}
> {
>   assignees?: {
>     id?: number | string | null,
>     name?: string | null
>   }[] | null,
>   date?: {
>     due?: string | null,
>     completed?: string | null
>   } | null,
>   status?: string | null
> }
> ```

***

## Storms

### acceptInvite

`storms.acceptInvite`

Accept a Storm invite for the token holder

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.acceptInvite({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### close

`storms.close`

Close a Storm; reopening restores it

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.close({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

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**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### create

`storms.create`

Create a Storm

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.create({ plan: 'personal', title: 'Sprint Planning', description: 'Weekly sprint board' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `plan` | `personal \| student \| educator \| team` | Yes | The plan to create the Storm under; student and educator need that plan, team needs team\_id. |
| `title` | `string` | Yes | — |
| `description` | `string` | No | — |
| `template` | `number` | No | — |
| `votesperuser` | `number` | No | — |
| `avatars` | `0 \| 1` | No | — |
| `ideacreator` | `0 \| 1` | No | — |
| `team_id` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### declineInvite

`storms.declineInvite`

Decline a Storm invite for the token holder

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.declineInvite({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### duplicate

`storms.duplicate`

Duplicate a Storm

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.duplicate({ stormId: 49999, stormname: 'My Copied Storm' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |
| `stormname` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `stormid` | `number \| null` | No | — |
| `stormkey` | `string \| null` | No | — |

***

### favorite

`storms.favorite`

Star a Storm

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.favorite({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

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`

```ts theme={null}
await corsair.stormboard.api.storms.get({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |
| `thumbnail` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `storm` | `object` | Yes | — |

> [accordion] storm full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   key?: string | null,
>   title?: string | null,
>   description?: string | null,
>   admin?: number | null,
>   favorite?: number | null,
>   palette?: string | null,
>   closed?: boolean | null,
>   team?: {
>     id?: number | string | null
>   } | null,
>   activity?: number | null,
>   votesperuser?: number | null,
>   votesperadmin?: number | null,
>   avatars?: number | null,
>   ideacreator?: number | null,
>   chatlocked?: number | null
> }
> ```

***

### getAccess

`storms.getAccess`

Read the token holder's access to a Storm

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.storms.getAccess({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `administrator` | `boolean \| null` | No | — |
| `type` | `string \| null` | No | — |

***

### getTemplate

`storms.getTemplate`

Read a Storm's template sections

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.storms.getTemplate({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `template` | `object[] \| null` | No | — |

> [accordion] template full type
>
> ```ts theme={null}
> {
>   index?: string | null,
>   name?: string | null,
>   description?: string | null,
>   character?: string | null,
>   color?: string | null,
>   type?: string | null,
>   subsections?: any | null
> }[] | null
> ```

***

### invite

`storms.invite`

Invite participants to a Storm by email; sends mail that cannot be recalled

**Risk:** `destructive` · **Irreversible**

```ts theme={null}
await corsair.stormboard.api.storms.invite({ stormId: 49999, participants: ["yoda@jedicouncil.com"], type: "contributor" });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |
| `participants` | `string[]` | Yes | Email addresses of the participants to invite. |
| `message` | `string` | No | — |
| `type` | `contributor \| viewer` | No | The access the invite grants; the API defaults to contributor. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `invited` | `number \| null` | No | — |

***

### join

`storms.join`

Join a Storm with its key

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.join({ stormid: 49999, stormkey: 'piece335' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormid` | `number` | Yes | — |
| `stormkey` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### leave

`storms.leave`

Leave a Storm

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.leave({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### list

`storms.list`

List your Storms with search, ordering and paging

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.storms.list({ status: "open", order: "activity", results: 50 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `team` | `number` | No | — |
| `folder` | `number` | No | — |
| `needle` | `string` | No | — |
| `status` | `open \| closed` | No | Filter by Storm state; the API defaults to open. |
| `start` | `number` | No | — |
| `order` | `activity \| alpha \| frequency \| starred` | No | Sort order: activity (last active, the default), alpha (A-Z), frequency or starred. |
| `results` | `number` | No | — |

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**

| Name | Type | Required | Description |
| - | - | - | - |
| `hasmore` | `boolean \| null` | No | — |
| `storms` | `object[]` | Yes | — |

> [accordion] storms full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   key?: string | null,
>   title?: string | null,
>   description?: string | null,
>   admin?: number | null,
>   favorite?: number | null,
>   palette?: string | null,
>   closed?: boolean | null,
>   team?: {
>     id?: number | string | null
>   } | null,
>   activity?: number | null,
>   votesperuser?: number | null,
>   votesperadmin?: number | null,
>   avatars?: number | null,
>   ideacreator?: number | null,
>   chatlocked?: number | null
> }[]
> ```

***

### listConnectors

`storms.listConnectors`

List the line connectors in a Storm

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.storms.listConnectors({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `connectors` | `object[]` | Yes | — |

> [accordion] connectors full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   from?: number | string | null,
>   to?: number | string | null,
>   from_uuid?: string | null,
>   to_uuid?: string | null,
>   label?: string | null,
>   style?: {
>     color?: string | null,
>     fromEndType?: string | null,
>     toEndType?: string | null
>   } | null,
>   points?: any[] | null
> }[]
> ```

***

### listIdeas

`storms.listIdeas`

List a Storm's ideas, optionally filtered by last modified date

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.storms.listIdeas({ stormId: 49999, lastModifiedMin: '2024-01-01T00:00:00Z' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |
| `lastModifiedMin` | `string` | No | An ISO 8601 date; dates without a timezone are read as UTC. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideas` | `object[]` | Yes | — |

> [accordion] ideas full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   uuid?: string | null,
>   storm?: {
>     id?: number | string | null,
>     title?: string | null
>   } | null,
>   x?: number | null,
>   y?: number | null,
>   z?: number | null,
>   color?: string | null,
>   lock?: number | null,
>   comments?: number | null,
>   votes?: number | null,
>   type?: string | null,
>   data?: {
>     text?: string | null,
>     name?: string | null
>   } | null,
>   task?: Record<string, any> | null
> }[]
> ```

***

### listInvites

`storms.listInvites`

List your Storm invites

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.storms.listInvites({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `team` | `number` | No | — |
| `needle` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `hasmore` | `boolean \| null` | No | — |
| `storms` | `object[]` | Yes | — |

> [accordion] storms full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   key?: string | null,
>   title?: string | null,
>   description?: string | null,
>   admin?: number | null,
>   favorite?: number | null,
>   palette?: string | null,
>   closed?: boolean | null,
>   team?: {
>     id?: number | string | null
>   } | null,
>   activity?: number | null,
>   votesperuser?: number | null,
>   votesperadmin?: number | null,
>   avatars?: number | null,
>   ideacreator?: number | null,
>   chatlocked?: number | null
> }[]
> ```

***

### listUsers

`storms.listUsers`

List a Storm's participants with their activity

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.storms.listUsers({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `users` | `object[]` | Yes | — |

> [accordion] users full type
>
> ```ts theme={null}
> {
>   firstname?: string | null,
>   lastname?: string | null,
>   email?: string | null,
>   ideas?: number | null,
>   comments?: number | null,
>   votes?: number | null,
>   lastactivity?: string | null
> }[]
> ```

***

### reopen

`storms.reopen`

Re-open a closed Storm

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.reopen({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### unfavorite

`storms.unfavorite`

Remove a Storm's star

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.unfavorite({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output:** *empty object*

***

### update

`storms.update`

Update a Storm's title, description and settings

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.update({ stormId: 49999, title: 'My New Storm Title' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |
| `title` | `string` | No | — |
| `description` | `string \| null` | No | — |
| `template` | `number \| null` | No | — |
| `votesperuser` | `number` | No | — |
| `avatars` | `0 \| 1` | No | — |
| `ideacreator` | `0 \| 1` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### updateLegend

`storms.updateLegend`

Set the color labels of a Storm's legend

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.updateLegend({
	stormId: 49999,
	color: { yellow: 'General Tasks', pink: 'High Priority' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |
| `color` | `Record<string, string>` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### updateSection

`storms.updateSection`

Update one section of a Storm

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.storms.updateSection({ stormId: 49999, sectionIndex: 'abcdef123456', name: 'New Section Title' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |
| `sectionIndex` | `string` | Yes | The section index from storms.getTemplate, such as "abcdef123456". |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `character` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

## Tags

### createForIdea

`tags.createForIdea`

Set tag data on an idea

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.tags.createForIdea({
	ideaId: 1000000,
	data: { Owner: 'John Smith' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |
| `data` | `Record<string, string>` | Yes | — |

**Output:** *empty object*

***

### createForStorm

`tags.createForStorm`

Create a tag in a Storm

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.tags.createForStorm({ stormId: 49999, name: 'Integration ID' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |
| `name` | `string` | Yes | — |

**Output:** *empty object*

***

### getForIdea

`tags.getForIdea`

Read the tag data of an idea

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.tags.getForIdea({ ideaId: 1000000 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ideaId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, string>` | Yes | — |

***

### listForStorm

`tags.listForStorm`

List the tags in a Storm

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.tags.listForStorm({ stormId: 49999 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `stormId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `tags` | `object[]` | Yes | — |

> [accordion] tags full type
>
> ```ts theme={null}
> {
>   id?: number | string | null,
>   name?: string | null,
>   type?: string | null,
>   status?: string | null
> }[]
> ```

***

## Users

### create

`users.create`

Create a Stormboard user, which emails them a verification code, and return its API key

**Risk:** `destructive`

```ts theme={null}
await corsair.stormboard.api.users.create({
	firstname: 'James',
	lastname: 'Dean',
	email: 'james.dean@fake.com',
	username: 'james.dean',
	password: 'example-password',
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `firstname` | `string` | Yes | — |
| `lastname` | `string` | Yes | — |
| `email` | `string` | Yes | — |
| `username` | `string` | Yes | — |
| `password` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |
| `api_key` | `string \| null` | No | — |

***

### getAuth

`users.getAuth`

Read the account API keys with their creation dates

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.users.getAuth({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `auth` | `object[]` | Yes | — |

> [accordion] auth full type
>
> ```ts theme={null}
> {
>   key?: string | null,
>   created?: string | null,
>   expires?: string | null
> }[]
> ```

***

### getProfile

`users.getProfile`

Read the profile behind the token

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.users.getProfile({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `profile` | `object` | Yes | — |

> [accordion] profile full type
>
> ```ts theme={null}
> {
>   auth?: {
>     api_key?: string | null
>   } | null,
>   id?: number | string | null,
>   firstname?: string | null,
>   lastname?: string | null,
>   username?: string | null,
>   email?: string | null,
>   plan?: string | null,
>   team?: {
>     id?: number | string | null,
>     name?: string | null
>   } | boolean | null,
>   notifications?: {
>     dailyemail?: number | string | null,
>     newstormuser?: number | string | null,
>     newsletter?: number | string | null
>   } | null
> }
> ```

***

### test

`users.test`

Check that the token authenticates

**Risk:** `read`

```ts theme={null}
await corsair.stormboard.api.users.test({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number \| null` | No | — |
| `status` | `number \| null` | No | — |

***

### updateNotifications

`users.updateNotifications`

Update the account notification settings

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.users.updateNotifications({ dailyemail: 0, newsletter: 1 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `dailyemail` | `number` | No | 1 turns the notification on, 0 turns it off. |
| `newstormuser` | `number` | No | 1 turns the notification on, 0 turns it off. |
| `newsletter` | `number` | No | 1 turns the notification on, 0 turns it off. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### updateProfile

`users.updateProfile`

Update the profile behind the token

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.users.updateProfile({ firstname: 'James' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `firstname` | `string` | No | — |
| `lastname` | `string` | No | — |
| `email` | `string` | No | — |
| `username` | `string` | No | — |
| `password` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***

### verify

`users.verify`

Verify a Stormboard account with its verification code

**Risk:** `write`

```ts theme={null}
await corsair.stormboard.api.users.verify({ code: 'ABC123' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `code` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| number` | Yes | — |
| `id` | `number \| string \| null` | No | — |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.