GET api/groups/{groupid}/members?lastName={lastName}&groupPlanNo={groupPlanNo}&firstName={firstName}&page={page}&pagesize={pagesize}
Gets a collection of members based on the search paramaters and the group and plan (optional) associated with the authenticated user
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
groupid |
Identifier for Group for which you want to find members |
integer |
Required |
lastName |
Last name of member |
string |
Required |
groupPlanNo |
Identifier for Plan for which you want to find members (optional) |
integer |
Default value is 0 |
firstName |
First name of member (optional) |
string |
Default value is |
page |
Page number of result set to return (optional, default is 1) |
integer |
Default value is 1 |
pagesize |
Number of results to return per page (optional, default is 50, max is 100) |
integer |
Default value is 50 |
Body Parameters
None.
Response Information
Resource Description
Returns up to the 50 members matching the criteria for the given page number provided in the page parameter
PagedResultModelOfMemberModelName | Description | Type | Additional information |
---|---|---|---|
PageNumber | integer |
None. |
|
PageCount | integer |
None. |
|
PageSize | integer |
None. |
|
Items |
None. |
Response Formats
application/json, text/json, application/json-patch+json
Sample:
{ "pageNumber": 1, "pageCount": 2, "pageSize": 3, "items": [ { "url": "sample string 36", "id": 37, "salutation": "sample string 1", "firstName": "sample string 2", "middleName": "sample string 3", "lastName": "sample string 4", "suffix": "sample string 5", "emailAddress": "sample string 6", "gender": "sample string 7", "heightInches": 1, "ssn": "sample string 8", "doNotEmail": true, "doNotPhone": true, "alternateID": "sample string 11", "dateOfBirth": "2025-05-30T21:08:44.6478078-05:00", "comment": "sample string 13", "birthPlace": "sample string 14", "occupation": "sample string 15", "usCitizen": true, "military": true, "active": 16, "memberComment": "sample string 17", "hasMedicare": true, "medicareID": "sample string 19", "medicarePlan": "sample string 20", "medicareEffectiveDate": "2025-05-30T21:08:44.6488108-05:00", "locationName": "sample string 22", "dependantIndicator": "sample string 23", "criticalComment": "sample string 24", "identifier": "sample string 25", "diabetic": true, "isHospice": true, "nonCodedAllergies": "sample string 27", "sentToPharmacy": true, "cardholderID": "sample string 28", "secondaryCoverageOnly": true, "locked": true, "coverageLevelCode": "CHD - Children Only", "yearlyHouseholdIncome": 1.0, "isMDCaresPatient": true, "personCode": "sample string 29", "cobra": true, "isTestMember": true, "roomNumber": "sample string 31", "bedNumber": "sample string 32", "admittedDate": "2025-05-30T21:08:44.6488108-05:00", "dischargeDate": "2025-05-30T21:08:44.6488108-05:00", "cardHolderMemberID": 33, "currentPatientPlan": { "planContractNo": 1, "contractCode": "sample string 1", "contractName": "sample string 2", "groupID": 1, "groupPlanNo": 1, "planName": "sample string 3", "facilityARTypeNo": 1, "arShortCode": "sample string 4", "effectiveStartDate": "2025-05-30T21:08:44.6488108-05:00", "effectiveEndDate": "2025-05-30T21:08:44.6488108-05:00" }, "clientID": "sample string 34", "externalID": "sample string 35", "currentFormulary": { "url": "sample string 2", "id": 3, "name": "sample string 1" } }, { "url": "sample string 36", "id": 37, "salutation": "sample string 1", "firstName": "sample string 2", "middleName": "sample string 3", "lastName": "sample string 4", "suffix": "sample string 5", "emailAddress": "sample string 6", "gender": "sample string 7", "heightInches": 1, "ssn": "sample string 8", "doNotEmail": true, "doNotPhone": true, "alternateID": "sample string 11", "dateOfBirth": "2025-05-30T21:08:44.6478078-05:00", "comment": "sample string 13", "birthPlace": "sample string 14", "occupation": "sample string 15", "usCitizen": true, "military": true, "active": 16, "memberComment": "sample string 17", "hasMedicare": true, "medicareID": "sample string 19", "medicarePlan": "sample string 20", "medicareEffectiveDate": "2025-05-30T21:08:44.6488108-05:00", "locationName": "sample string 22", "dependantIndicator": "sample string 23", "criticalComment": "sample string 24", "identifier": "sample string 25", "diabetic": true, "isHospice": true, "nonCodedAllergies": "sample string 27", "sentToPharmacy": true, "cardholderID": "sample string 28", "secondaryCoverageOnly": true, "locked": true, "coverageLevelCode": "CHD - Children Only", "yearlyHouseholdIncome": 1.0, "isMDCaresPatient": true, "personCode": "sample string 29", "cobra": true, "isTestMember": true, "roomNumber": "sample string 31", "bedNumber": "sample string 32", "admittedDate": "2025-05-30T21:08:44.6488108-05:00", "dischargeDate": "2025-05-30T21:08:44.6488108-05:00", "cardHolderMemberID": 33, "currentPatientPlan": { "planContractNo": 1, "contractCode": "sample string 1", "contractName": "sample string 2", "groupID": 1, "groupPlanNo": 1, "planName": "sample string 3", "facilityARTypeNo": 1, "arShortCode": "sample string 4", "effectiveStartDate": "2025-05-30T21:08:44.6488108-05:00", "effectiveEndDate": "2025-05-30T21:08:44.6488108-05:00" }, "clientID": "sample string 34", "externalID": "sample string 35", "currentFormulary": { "url": "sample string 2", "id": 3, "name": "sample string 1" } } ], "totalRecordCount": 4 }