Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Plans

List organization plans

plans.list(PlanListParams**kwargs) -> SyncPageNumberPage[PlanListResponse]
GET/v1/plans

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

ParametersExpand Collapse
limit: Optional[int]

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

minimum1
maximum100
page: Optional[int]

Page number (default: 1)

minimum1
ReturnsExpand Collapse
class PlanListResponse: …
id: str
name: str

List organization plans

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
page = client.plans.list()
page = page.data[0]
print(page.id)
{
  "data": [
    {
      "id": "pln_abc123def456",
      "name": "Basic Care"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}
Returns Examples
{
  "data": [
    {
      "id": "pln_abc123def456",
      "name": "Basic Care"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}