GET api/MemberDirectory?lastName={lastName}&firstName={firstName}&cardholderID={cardholderID}&personCode={personCode}&arCode={arCode}&contractCode={contractCode}&page={page}&pagesize={pagesize}
Retrieves a paginated list of members.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| lastName |
The last name of the member to search for. Required if no other primary search parameter is provided. |
string |
Default value is |
| firstName |
The first name of the member to search for. *Optional*. |
string |
Default value is |
| cardholderID |
The cardholder ID of the member to search for. Required if `lastName` is not provided or when `personCode` is used. |
string |
Default value is |
| personCode |
The person code associated with the member. *Optional.* Must not be used as the only search parameter. |
string |
Default value is |
| arCode |
The AR code associated with the member. *Optional*. |
string |
Default value is |
| contractCode |
The contract code associated with the member. *Optional*. |
string |
Default value is |
| page |
The page number of the results to return. *Optional*; default is 1. Must be a positive integer. |
integer |
Default value is 1 |
| pagesize |
The number of results to return per page. *Optional*; default is 50. Must be between 1 and 100. |
integer |
Default value is 50 |
Body Parameters
None.
Response Information
Resource Description
A paginated list of members matching the search criteria.
PagedResultModelOfMemberModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PageNumber | integer |
None. |
|
| PageCount | integer |
None. |
|
| PageSize | integer |
None. |
|
| Items | Collection of MemberModel |
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 38",
"id": 39,
"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-07-16T15:09:19.363264-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-07-16T15:09:19.363264-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,
"ignoreMemberInfoInClaims": true,
"setMemberInfoNextClaim": true,
"roomNumber": "sample string 33",
"bedNumber": "sample string 34",
"admittedDate": "2025-07-16T15:09:19.363264-05:00",
"dischargeDate": "2025-07-16T15:09:19.363264-05:00",
"cardHolderMemberID": 35,
"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-07-16T15:09:19.363264-05:00",
"effectiveEndDate": "2025-07-16T15:09:19.363264-05:00"
},
"clientID": "sample string 36",
"externalID": "sample string 37",
"currentFormulary": {
"url": "sample string 2",
"id": 3,
"name": "sample string 1"
}
},
{
"url": "sample string 38",
"id": 39,
"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-07-16T15:09:19.363264-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-07-16T15:09:19.363264-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,
"ignoreMemberInfoInClaims": true,
"setMemberInfoNextClaim": true,
"roomNumber": "sample string 33",
"bedNumber": "sample string 34",
"admittedDate": "2025-07-16T15:09:19.363264-05:00",
"dischargeDate": "2025-07-16T15:09:19.363264-05:00",
"cardHolderMemberID": 35,
"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-07-16T15:09:19.363264-05:00",
"effectiveEndDate": "2025-07-16T15:09:19.363264-05:00"
},
"clientID": "sample string 36",
"externalID": "sample string 37",
"currentFormulary": {
"url": "sample string 2",
"id": 3,
"name": "sample string 1"
}
}
],
"totalRecordCount": 4
}