GET api/groups/{groupid}/groupplans/{groupplanid}/formularies/{formularyid}/plantiercopays?page={page}&pagesize={pagesize}
Gets a collection of Plan Tier Copays by formulary identifier, group identifier, and group plan identifier
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
groupid |
Group identifier |
integer |
Required |
groupplanid |
Group Plan Identifier |
integer |
Required |
formularyid |
Plan Formulary Identifier |
integer |
Required |
page |
The 1-based index of the page of plan tier copays to return (optional, 1 by default) |
integer |
Default value is 1 |
pagesize |
The number of plan tier copays to return per page (optional, 25 by default, max 100) |
integer |
Default value is 25 |
Body Parameters
None.
Response Information
Resource Description
A list of plan tier copay objects
PagedResultModelOfPlanTierCopayModelName | Description | Type | Additional information |
---|---|---|---|
PageNumber | integer |
None. |
|
PageCount | integer |
None. |
|
PageSize | integer |
None. |
|
Items | Collection of PlanTierCopayModel |
None. |
|
TotalRecordCount | integer |
None. |
Response Formats
application/json, text/json, application/json-patch+json
Sample:
{ "pageNumber": 1, "pageCount": 2, "pageSize": 3, "items": [ { "url": "sample string 5", "id": 6, "formularyTierId": 1, "formularyTierUrl": "sample string 2", "copayId": 1, "oopCopayUrl": "sample string 3", "oopCopayId": 1, "copayUrl": "sample string 4", "createdOn": "2025-05-30T21:28:34.4491831-05:00" }, { "url": "sample string 5", "id": 6, "formularyTierId": 1, "formularyTierUrl": "sample string 2", "copayId": 1, "oopCopayUrl": "sample string 3", "oopCopayId": 1, "copayUrl": "sample string 4", "createdOn": "2025-05-30T21:28:34.4491831-05:00" } ], "totalRecordCount": 4 }