Skip to main content
GET
/
v1
/
plans
List Plans
curl --request GET \
  --url https://api-sandbox.penelope.health/v1/plans \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "plan_id": "KMQTZ_commercial_US",
      "payer_id": "KMQTZ",
      "payer_name": "UnitedHealthcare",
      "plan_type": "commercial",
      "country_wide": false,
      "states": [
        "CA"
      ]
    },
    {
      "plan_id": "HPQRS_commercial_US",
      "payer_id": "HPQRS",
      "payer_name": "Aetna",
      "plan_type": "commercial",
      "country_wide": false,
      "states": [
        "CA"
      ]
    }
  ],
  "limit": 20,
  "offset": 0,
  "has_more": false
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
limit
integer
default:20

Maximum number of results to return

Required range: 1 <= x <= 100
Example:

20

​
offset
integer
default:0

Number of results to skip for pagination

Required range: x >= 0
Example:

0

​
plan_types
enum<string>[] | null

Filter by plan types

Line-of-business categories.

Available options:
commercial,
medicare_part_a,
medicare_part_b,
medicare_advantage,
medicaid,
individual_aca
Example:
["commercial"]
​
payer_ids
string[] | null

Filter by payer IDs

Example:
["KMQTZ"]

Response

Successful Response

​
data
InsurancePlanResponse · object[]
required

Array of result objects

​
limit
integer
required

Maximum number of results requested

Example:

20

​
offset
integer
required

Number of results skipped for pagination

Example:

0

​
has_more
boolean
required

True if more results exist beyond this page

Example:

false