Skip to main content
GET
Get a list of all Group Plans

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

group_id
string<uuid>
required

The unique identifier of the group for which you would like to view plans

Example:

"31559b4b-e45a-4df8-84f6-2220d7ed0c3a"

Query Parameters

status
string

Status of the group plans for which you would like to filter

line_of_coverage
string

Line of coverage of the group plans for which you would like to filter

carrier_id
string<uuid>

The unique identifier of the carrier of the group plans for which you would like to filter

Example:

"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"

effective_date
string

The relative date on which to view the state of the record

page_size
integer

The max size of each page of results

offset
integer

The integer offset at which to start the page. Possible values are 0 to total_records - 1

Response

200 - application/json

Successful Response - Returns all matching Plans

meta
object
required

Metadata associated with the response data

response
object[]
required

List of group plan results