# Contexts

## List contexts

`client.v1.contexts.list(ContextListParamsquery?, RequestOptionsoptions?): void`

**get** `/api/v1/contexts`

List contexts

### Parameters

- `query: ContextListParams`

  - `cursor?: string`

    Opaque cursor from the previous response `nextCursor`.

  - `includeDeleted?: boolean`

  - `limit?: number`

  - `spaceId?: string`

    Optional space id; when omitted, the user’s default space is used.

### Example

```typescript
import Fluidwave from 'fluidwave';

const client = new Fluidwave();

await client.v1.contexts.list();
```

## Create context

`client.v1.contexts.create(ContextCreateParamsparams?, RequestOptionsoptions?): void`

**post** `/api/v1/contexts`

Increments the Replicache space version via repVersionIncrement after writing.

### Parameters

- `params: ContextCreateParams`

  - `spaceId?: string`

    Optional space id; when omitted, the user’s default space is used.

### Example

```typescript
import Fluidwave from 'fluidwave';

const client = new Fluidwave();

await client.v1.contexts.create();
```

## Get context

`client.v1.contexts.retrieve(stringcontextID, ContextRetrieveParamsquery?, RequestOptionsoptions?): void`

**get** `/api/v1/contexts/{contextId}`

Get context

### Parameters

- `contextID: string`

- `query: ContextRetrieveParams`

  - `spaceId?: string`

    Optional space id; when omitted, the user’s default space is used.

### Example

```typescript
import Fluidwave from 'fluidwave';

const client = new Fluidwave();

await client.v1.contexts.retrieve('contextId');
```

## Update context

`client.v1.contexts.update(stringcontextID, ContextUpdateParamsparams?, RequestOptionsoptions?): void`

**patch** `/api/v1/contexts/{contextId}`

Increments the Replicache space version via repVersionIncrement after writing.

### Parameters

- `contextID: string`

- `params: ContextUpdateParams`

  - `spaceId?: string`

    Optional space id; when omitted, the user’s default space is used.

### Example

```typescript
import Fluidwave from 'fluidwave';

const client = new Fluidwave();

await client.v1.contexts.update('contextId');
```

## Delete context (soft)

`client.v1.contexts.delete(stringcontextID, ContextDeleteParamsparams?, RequestOptionsoptions?): void`

**delete** `/api/v1/contexts/{contextId}`

Increments the Replicache space version via repVersionIncrement after writing.

### Parameters

- `contextID: string`

- `params: ContextDeleteParams`

  - `spaceId?: string`

    Optional space id; when omitted, the user’s default space is used.

### Example

```typescript
import Fluidwave from 'fluidwave';

const client = new Fluidwave();

await client.v1.contexts.delete('contextId');
```