# Plans

## List organization plans

`client.plans.list(PlanListParamsquery?, RequestOptionsoptions?): PageNumberPage<PlanListResponse>`

**get** `/v1/plans`

Returns a paginated list of benefit plans linked to the authenticated organization.

### Parameters

- `query: PlanListParams`

  - `limit?: number`

    Items per page (default: 20, max: 100)

  - `page?: number`

    Page number (default: 1)

### Returns

- `PlanListResponse`

  - `id: string`

  - `name: string`

### Example

```typescript
import VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const planListResponse of client.plans.list()) {
  console.log(planListResponse.id);
}
```

#### Response

```json
{
  "data": [
    {
      "id": "pln_abc123def456",
      "name": "Basic Care"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}
```

## Domain Types

### Plan List Response

- `PlanListResponse`

  - `id: string`

  - `name: string`