GET
/
api
/
v1
/
groups
/
{group_id}
/
group_enrollments
Get a list of all Group Enrollments
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/groups/{group_id}/group_enrollments
{
  "meta": {
    "offset": 0,
    "page_num": 1,
    "page_size": 20,
    "total_records": 2
  },
  "response": [
    {
      "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
      "created": 1557512389,
      "effective_end_date": "2019-12-31",
      "effective_start_date": "2019-01-01",
      "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
      "id": "7499ea07-76c9-40f2-992b-952259e98384",
      "line_of_coverage": "medical",
      "modified": 1543215342,
      "open_enrollment_end_date": "2019-02-01",
      "open_enrollment_start_date": "2019-01-01",
      "status": "active",
      "version": "c2292b67-0382-45e9-a378-b52c4129f672"
    },
    {
      "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
      "created": 1557512389,
      "effective_end_date": "2019-12-31",
      "effective_start_date": "2019-01-01",
      "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
      "id": "25cdcb18-7d01-4599-9f65-d38b36d7c370",
      "line_of_coverage": "dental",
      "modified": 1543215342,
      "open_enrollment_end_date": "2019-02-01",
      "open_enrollment_start_date": "2019-01-01",
      "status": "active",
      "version": "55c4bcbb-98ab-448d-a5b4-d7d835327f72"
    }
  ]
}

Path Parameters

​
group_id
string
required

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

Example:

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

Query Parameters

​
effective_date
string

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

​
status
string

The status of the group enrollments you would like to view

​
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 Group Enrollments

The response is of type object.