List organization plans

plans.list(**kwargs) -> PageNumberPage<PlanListResponse { id, name } >

GET/v1/plans

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

ParametersExpand Collapse

limit: Integer

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

minimum1

maximum100

page: Integer

Page number (default: 1)

minimum1

ReturnsExpand Collapse

class PlanListResponse { id, name }

id: String

name: String

List organization plans

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

page = vitable_connect.plans.list

puts(page)

{
  "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
  }
}