> ## 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.

# Klipfolio API reference

> API reference for the Klipfolio plugin in Corsair: every `klipfolio.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).

## Clients

### createClient

`clients.createClient`

Create Client on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.clients.createClient({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `name` | `string` | Yes | — |
| `description` | `string` | No | — |
| `status` | `setup \| trial \| active \| disabled` | No | — |
| `seats` | `number` | No | — |
| `custom_theme` | `boolean` | No | — |
| `external_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### createClientSettings

`clients.createClientSettings`

Set Client Settings on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.clients.createClientSettings({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `dpn.env.date.language.tag` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteClient

`clients.deleteClient`

Delete Client on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.clients.deleteClient({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteClientProperties

`clients.deleteClientProperties`

Delete Client Property on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.clients.deleteClientProperties({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `name` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteClientShareRight

`clients.deleteClientShareRight`

Revoke Group Access to Client on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.clients.deleteClientShareRight({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `groupId` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### enableDirectBillingClient

`clients.enableDirectBillingClient`

Switch a client to direct billing on Klipfolio (cannot be undone)

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.clients.enableDirectBillingClient({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### extendTrialClient

`clients.extendTrialClient`

Extend Trial on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.clients.extendTrialClient({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `days` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### listClients

`clients.listClients`

List Clients on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.clients.listClients({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `external_id` | `string` | No | — |
| `status` | `setup \| trial \| active \| disabled` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   clients: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveClient

`clients.retrieveClient`

Get Client on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.clients.retrieveClient({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `full` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveClientFeatures

`clients.retrieveClientFeatures`

Get Client Features on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.clients.retrieveClientFeatures({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveClientProperties

`clients.retrieveClientProperties`

Get Client Properties on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.clients.retrieveClientProperties({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveClientResources

`clients.retrieveClientResources`

Get Client Resources on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.clients.retrieveClientResources({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `full` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveClientSettings

`clients.retrieveClientSettings`

Get Client Settings on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.clients.retrieveClientSettings({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveClientShareRights

`clients.retrieveClientShareRights`

Get Client Share Rights on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.clients.retrieveClientShareRights({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### setClientShareRights

`clients.setClientShareRights`

Update Client Share Rights on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.clients.setClientShareRights({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `groups` | `any[]` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateClient

`clients.updateClient`

Update Client on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.clients.updateClient({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `status` | `setup \| trial \| active \| disabled` | No | — |
| `seats` | `number` | No | — |
| `custom_theme` | `boolean` | No | — |
| `external_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateClientFeatures

`clients.updateClientFeatures`

Update Client Features on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.clients.updateClientFeatures({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `features` | `any[]` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateClientProperties

`clients.updateClientProperties`

Update Client Properties on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.clients.updateClientProperties({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `properties` | `Record<string, any>` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateClientResources

`clients.updateClientResources`

Update Client Resources on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.clients.updateClientResources({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `resources` | `any[]` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

## Datasources

### createDatasource

`datasources.createDatasource`

Create Data Source on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.datasources.createDatasource({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `format` | `string` | No | — |
| `connector` | `string` | No | — |
| `refresh_interval` | `number` | No | — |
| `properties` | `Record<string, any>` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### createDatasourceInstances

`datasources.createDatasourceInstances`

Create Data Source Instance on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.datasources.createDatasourceInstances({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `client_id` | `string` | No | — |
| `datasource_id` | `string` | Yes | — |
| `properties` | `Record<string, any>` | No | — |
| `no_refresh` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteDatasource

`datasources.deleteDatasource`

Delete Data Source on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.datasources.deleteDatasource({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteDatasourceInstances

`datasources.deleteDatasourceInstances`

Delete Data Source Instance on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.datasources.deleteDatasourceInstances({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteDatasourceInstancesProperties

`datasources.deleteDatasourceInstancesProperties`

Delete Data Source Instance Property on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.datasources.deleteDatasourceInstancesProperties({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `name` | `string` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteDatasourceProperties

`datasources.deleteDatasourceProperties`

Delete a Data Source Property on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.datasources.deleteDatasourceProperties({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `name` | `string` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteDatasourceShareRight

`datasources.deleteDatasourceShareRight`

Delete Data Source Share Right on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.datasources.deleteDatasourceShareRight({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `groupId` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `type` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteInstancesDatasource

`datasources.deleteInstancesDatasource`

Delete Instances on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.datasources.deleteInstancesDatasource({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `last_access` | `string` | No | — |
| `keep_latest_instance` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### disableDatasource

`datasources.disableDatasource`

Disable a Data Source on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.datasources.disableDatasource({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### enableDatasource

`datasources.enableDatasource`

Enable a Data Source on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.datasources.enableDatasource({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### importDatasource

`datasources.importDatasource`

Import a Data Source on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.datasources.importDatasource({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### listDatasourceInstances

`datasources.listDatasourceInstances`

List Data Source Instances on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.datasources.listDatasourceInstances({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `datasource_id` | `string` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   instances: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### listDatasources

`datasources.listDatasources`

List Data Sources on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.datasources.listDatasources({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   datasources: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### refreshDatasource

`datasources.refreshDatasource`

Refresh Multiple Data Sources on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.datasources.refreshDatasource({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `client_id` | `string` | No | — |
| `datasources` | `string[]` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### refreshDatasourceInstances

`datasources.refreshDatasourceInstances`

Refresh a Data Source Instance on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.datasources.refreshDatasourceInstances({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveDatasource

`datasources.retrieveDatasource`

Get Data Source on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.datasources.retrieveDatasource({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveDatasourceInstances

`datasources.retrieveDatasourceInstances`

Get Data Source Instance on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.datasources.retrieveDatasourceInstances({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveDatasourceInstancesData

`datasources.retrieveDatasourceInstancesData`

Get Data Source Instance Data on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.datasources.retrieveDatasourceInstancesData({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output:** `string`

***

### retrieveDatasourceInstancesProperties

`datasources.retrieveDatasourceInstancesProperties`

Get Data Source Instance Properties on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.datasources.retrieveDatasourceInstancesProperties({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveDatasourceProperties

`datasources.retrieveDatasourceProperties`

Get Data Source Properties on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.datasources.retrieveDatasourceProperties({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveDatasourceShareRights

`datasources.retrieveDatasourceShareRights`

Get Data Source Share Rights on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.datasources.retrieveDatasourceShareRights({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### setDatasourceShareRights

`datasources.setDatasourceShareRights`

Update Data Source Share Rights on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.datasources.setDatasourceShareRights({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `users` | `any[]` | No | — |
| `groups` | `any[]` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateDatasource

`datasources.updateDatasource`

Update Data Source on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.datasources.updateDatasource({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `refresh_interval` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateDatasourceInstancesData

`datasources.updateDatasourceInstancesData`

Replace a data source instance's data on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.datasources.updateDatasourceInstancesData({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `rawContent` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateDatasourceInstancesProperties

`datasources.updateDatasourceInstancesProperties`

Create or Update Data Source Instance Properties on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.datasources.updateDatasourceInstancesProperties({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `properties` | `Record<string, any>` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateDatasourceProperties

`datasources.updateDatasourceProperties`

Create or Update Data Source Properties on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.datasources.updateDatasourceProperties({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `properties` | `Record<string, any>` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

## Groups

### addGroupDefaultTabs

`groups.addGroupDefaultTabs`

Add Dashboard to Group on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.groups.addGroupDefaultTabs({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `tab_id` | `string` | No | — |
| `can_edit` | `boolean` | No | — |
| `visibility` | `library \| dashboard \| permanent` | No | — |
| `index` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### createGroup

`groups.createGroup`

Create Group on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.groups.createGroup({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `name` | `string` | Yes | — |
| `description` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteGroup

`groups.deleteGroup`

Delete Group on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.groups.deleteGroup({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteGroupDefaultTab

`groups.deleteGroupDefaultTab`

Delete Group Default Tab on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.groups.deleteGroupDefaultTab({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `id2` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteGroupUser

`groups.deleteGroupUser`

Delete User from Group on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.groups.deleteGroupUser({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `id2` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### listGroups

`groups.listGroups`

List Groups on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.groups.listGroups({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   groups: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveGroup

`groups.retrieveGroup`

Get Group on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.groups.retrieveGroup({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `full` | `boolean` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveGroupDefaultTab

`groups.retrieveGroupDefaultTab`

Get Group Default Tab on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.groups.retrieveGroupDefaultTab({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `id2` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveGroupDefaultTabs

`groups.retrieveGroupDefaultTabs`

List Group Default Tabs on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.groups.retrieveGroupDefaultTabs({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   tabs: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveGroupUsers

`groups.retrieveGroupUsers`

List Users in Group on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.groups.retrieveGroupUsers({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   users: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateGroup

`groups.updateGroup`

Update Group on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.groups.updateGroup({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateGroupDefaultTab

`groups.updateGroupDefaultTab`

Update Group Default Tab on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.groups.updateGroupDefaultTab({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `id2` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `can_edit` | `boolean` | No | — |
| `visibility` | `library \| dashboard \| permanent` | No | — |
| `index` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateGroupUser

`groups.updateGroupUser`

Add User to Group on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.groups.updateGroupUser({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `userid` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

## Klips

### createKlip

`klips.createKlip`

Create Klip on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.klips.createKlip({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `name` | `string` | Yes | — |
| `description` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `schema` | `Record<string, any>` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### createKlipAnnotations

`klips.createKlipAnnotations`

Create annotation on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.klips.createKlipAnnotations({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `body` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteKlip

`klips.deleteKlip`

Delete Klip on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.klips.deleteKlip({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteKlipAnnotation

`klips.deleteKlipAnnotation`

Delete annotation on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.klips.deleteKlipAnnotation({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `annotationId` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteKlipShareRights

`klips.deleteKlipShareRights`

Delete Klip share rights on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.klips.deleteKlipShareRights({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `groupId` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### importKlip

`klips.importKlip`

Import Klip to client account on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.klips.importKlip({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### listKlips

`klips.listKlips`

List Klips on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.klips.listKlips({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `datasource_id` | `string` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   klips: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveKlip

`klips.retrieveKlip`

Get Klip on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.klips.retrieveKlip({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `full` | `boolean` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveKlipAnnotation

`klips.retrieveKlipAnnotation`

Get one annotation on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.klips.retrieveKlipAnnotation({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `annotationId` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveKlipAnnotations

`klips.retrieveKlipAnnotations`

List annotations on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.klips.retrieveKlipAnnotations({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `start_date` | `string` | No | — |
| `end_date` | `string` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveKlipClientInstances

`klips.retrieveKlipClientInstances`

Get Klip Client Instances on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.klips.retrieveKlipClientInstances({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveKlipSchema

`klips.retrieveKlipSchema`

Get Klip schema on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.klips.retrieveKlipSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveKlipShareRights

`klips.retrieveKlipShareRights`

Get Klip share rights on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.klips.retrieveKlipShareRights({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### setKlipShareRights

`klips.setKlipShareRights`

Update Klip share rights on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.klips.setKlipShareRights({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `groups` | `Record<string, any>[]` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateFromParentKlip

`klips.updateFromParentKlip`

Update client instance from parent (update\_from\_parent) on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.klips.updateFromParentKlip({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateKlip

`klips.updateKlip`

Update Klip on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.klips.updateKlip({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `klip_id` | `string` | Yes | — |
| `name` | `string` | Yes | — |
| `description` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateKlipAnnotation

`klips.updateKlipAnnotation`

Update annotation on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.klips.updateKlipAnnotation({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `annotationId` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `body` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateKlipSchema

`klips.updateKlipSchema`

Update Klip schema on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.klips.updateKlipSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `wire_id` | `string` | Yes | — |
| `workspace` | `object` | Yes | — |
| `components` | `Record<string, any>[]` | Yes | — |

> [accordion] workspace full type
>
> ```ts theme={null}
> {
>   datasources: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

## Misc

### createDashboardPublishedLinks

`misc.createDashboardPublishedLinks`

Create published link on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.misc.createDashboardPublishedLinks({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `dashboardId` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `name` | `string` | Yes | — |
| `password` | `string` | No | — |
| `isPublic` | `boolean` | No | — |
| `theme` | `light \| dark` | No | — |
| `logo` | `string` | No | — |
| `social` | `boolean` | No | — |
| `wantsAdvertising` | `boolean` | No | — |
| `useIpRanges` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteDashboardPublishedLinks

`misc.deleteDashboardPublishedLinks`

Delete published link on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.misc.deleteDashboardPublishedLinks({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `publishedLinkId` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### listDashboardPublishedLinks

`misc.listDashboardPublishedLinks`

Get published link(s) on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.misc.listDashboardPublishedLinks({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `dashboard_id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   published_links: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveProfile

`misc.retrieveProfile`

Get profile on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.misc.retrieveProfile({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `full` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateDashboardPublishedLinks

`misc.updateDashboardPublishedLinks`

Update published link on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.misc.updateDashboardPublishedLinks({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `publishedLinkId` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `name` | `string` | No | — |
| `password` | `string` | No | — |
| `isPublic` | `boolean` | No | — |
| `theme` | `light \| dark` | No | — |
| `logo` | `string` | No | — |
| `social` | `boolean` | No | — |
| `wantsAdvertising` | `boolean` | No | — |
| `useIpRanges` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

## Roles

### createRole

`roles.createRole`

Create role on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.roles.createRole({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `name` | `string` | Yes | — |
| `description` | `string` | Yes | — |
| `permissions` | `any[]` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteRole

`roles.deleteRole`

Delete role on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.roles.deleteRole({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteRolePermissions

`roles.deleteRolePermissions`

Remove role permission on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.roles.deleteRolePermissions({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `name` | `string` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteRoleUser

`roles.deleteRoleUser`

Delete user from role on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.roles.deleteRoleUser({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `userid` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### listRoles

`roles.listRoles`

List roles on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.roles.listRoles({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   roles: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveRole

`roles.retrieveRole`

Get role on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.roles.retrieveRole({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `full` | `boolean` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveRolePermissions

`roles.retrieveRolePermissions`

Get role permissions on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.roles.retrieveRolePermissions({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveRoleUsers

`roles.retrieveRoleUsers`

List users for role on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.roles.retrieveRoleUsers({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateRole

`roles.updateRole`

Update role on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.roles.updateRole({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `name` | `string` | Yes | — |
| `description` | `string` | Yes | — |
| `permissions` | `any[]` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateRolePermissions

`roles.updateRolePermissions`

Update role permissions on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.roles.updateRolePermissions({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `permissions` | `string[]` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateRoleUser

`roles.updateRoleUser`

Add user to role on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.roles.updateRoleUser({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `userId` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

## Tabs

### createTab

`tabs.createTab`

Create tab on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.tabs.createTab({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `client_id` | `string` | No | — |
| `name` | `string` | Yes | — |
| `description` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteTab

`tabs.deleteTab`

Delete tab on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.tabs.deleteTab({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteTabKlipInstance

`tabs.deleteTabKlipInstance`

Delete Klip from tab on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.tabs.deleteTabKlipInstance({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `klipInstanceId` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteTabShareRight

`tabs.deleteTabShareRight`

Revoke group access to tab on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.tabs.deleteTabShareRight({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `groupId` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### importTab

`tabs.importTab`

Import tab to client account on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.tabs.importTab({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `tab_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### listTabs

`tabs.listTabs`

List tabs on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.tabs.listTabs({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   tabs: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveTab

`tabs.retrieveTab`

Get tab on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.tabs.retrieveTab({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `full` | `boolean` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveTabKlipInstances

`tabs.retrieveTabKlipInstances`

List Klip instances on tab on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.tabs.retrieveTabKlipInstances({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   klip_instances: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveTabLayout

`tabs.retrieveTabLayout`

Get tab layout on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.tabs.retrieveTabLayout({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveTabShareRights

`tabs.retrieveTabShareRights`

Get tab share rights on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.tabs.retrieveTabShareRights({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### setTabShareRights

`tabs.setTabShareRights`

Update tab share rights on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.tabs.setTabShareRights({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `groups` | `Record<string, any>[]` | No | — |
| `users` | `Record<string, any>[]` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateTab

`tabs.updateTab`

Update tab on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.tabs.updateTab({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `name` | `string` | Yes | — |
| `description` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateTabKlipInstances

`tabs.updateTabKlipInstances`

Add Klip to tab on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.tabs.updateTabKlipInstances({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `klips` | `Record<string, any>[]` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateTabLayout

`tabs.updateTabLayout`

Replace a tab layout on Klipfolio (Klips left out are removed)

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.tabs.updateTabLayout({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `type` | `string` | Yes | — |
| `state` | `Record<string, any>` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

## Users

### createUser

`users.createUser`

Create User on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.users.createUser({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `send_email` | `boolean` | No | — |
| `first_name` | `string` | Yes | — |
| `last_name` | `string` | Yes | — |
| `roles` | `any[]` | Yes | — |
| `email` | `string` | Yes | — |
| `password` | `string` | No | — |
| `external_id` | `string` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteUser

`users.deleteUser`

Delete User on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.users.deleteUser({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteUserGroup

`users.deleteUserGroup`

Delete user from group on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.users.deleteUserGroup({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `groupId` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteUserProperties

`users.deleteUserProperties`

Delete user property on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.users.deleteUserProperties({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `name` | `string` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteUserRole

`users.deleteUserRole`

Delete user from role on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.users.deleteUserRole({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `roleid` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### deleteUserTabInstance

`users.deleteUserTabInstance`

Delete user tab instance on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.users.deleteUserTabInstance({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `tabInstanceId` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### listUsers

`users.listUsers`

Get Users on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.users.listUsers({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `client_id` | `string` | No | — |
| `email` | `string` | No | — |
| `external_id` | `string` | No | — |
| `full` | `boolean` | No | — |
| `include_roles` | `boolean` | No | — |
| `include_groups` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   users: {
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### resendInviteUser

`users.resendInviteUser`

Resend the invitation email to a user on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.users.resendInviteUser({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### resetPasswordUser

`users.resetPasswordUser`

Reset a user's password on Klipfolio

**Risk:** `destructive`

```ts theme={null}
await corsair.klipfolio.api.users.resetPasswordUser({});
```

**Input**

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveUser

`users.retrieveUser`

Get User by ID on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.users.retrieveUser({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `full` | `boolean` | No | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveUserGroups

`users.retrieveUserGroups`

Get user groups on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.users.retrieveUserGroups({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveUserProperties

`users.retrieveUserProperties`

Get user properties on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.users.retrieveUserProperties({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveUserRoles

`users.retrieveUserRoles`

Get user roles on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.users.retrieveUserRoles({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### retrieveUserTabInstances

`users.retrieveUserTabInstances`

Get user tab instances on Klipfolio

**Risk:** `read`

```ts theme={null}
await corsair.klipfolio.api.users.retrieveUserTabInstances({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateUser

`users.updateUser`

Update User on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.users.updateUser({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `first_name` | `string` | No | — |
| `last_name` | `string` | No | — |
| `external_id` | `string` | No | — |
| `email` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateUserGroup

`users.updateUserGroup`

Add user to group on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.users.updateUserGroup({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `groupId` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `can_edit` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateUserProperties

`users.updateUserProperties`

Update user properties on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.users.updateUserProperties({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `properties` | `Record<string, any>` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateUserRole

`users.updateUserRole`

Assign user to role on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.users.updateUserRole({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `roleId` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `wire_id` | `any[]` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***

### updateUserTabInstances

`users.updateUserTabInstances`

Add tabs to user on Klipfolio

**Risk:** `write`

```ts theme={null}
await corsair.klipfolio.api.users.updateUserTabInstances({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `client_id` | `string` | No | — |
| `tab_ids` | `string[]` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | No | — |
| `meta` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   status: number,
>   success: boolean
> }
> ```

***


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