GET api/members?lastName={lastName}&firstName={firstName}&cardholderID={cardholderID}&personCode={personCode}&arCode={arCode}&page={page}&pagesize={pagesize}

Retrieves a paginated list of members associated with the authenticated user's company, based on the provided search parameters. **Search Criteria:** - **Required:** Either lastName or cardholderID must be provided. - **Optional:** Additional parameters like firstName, personCode, and arCode can refine the search. **Pagination:** - Use the page and pagesize parameters to control the pagination of the results. - The pagesize has a default value of 50 and a maximum allowed value of 100. **Response Codes:** - **200 OK:** Successfully retrieved the list of members. - **400 Bad Request:** Invalid request parameters (e.g., neither lastName nor cardholderID provided, or pagesize exceeds the maximum allowed). - **404 Not Found:** No members found matching the search criteria, or the authenticated user's company is invalid. - **500 Internal Server Error:** An unexpected error occurred on the server.

Request Information

URI Parameters

Name	Description	Type	Additional information
lastName	The last name of the member to search for. Required if cardholderID is not 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.	string	Default value is
personCode	The person code associated with the member. This should be padded to three digits (e.g. 001). Optional.	string	Default value is
arCode	The AR code associated with the member. This value can be looked up on the FacilityArTypes endpoint - the ARShortCode is the value that should be used here. 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

Returns a paginated list of members matching the search criteria.

PagedResultModelOfMemberModel

Name	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 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-12-09T20:16:15.9862605-06:00",
      "comment": "sample string 12",
      "birthPlace": "sample string 13",
      "occupation": "sample string 14",
      "usCitizen": true,
      "military": true,
      "active": 15,
      "memberComment": "sample string 16",
      "hasMedicare": true,
      "medicareID": "sample string 18",
      "medicarePlan": "sample string 19",
      "medicareEffectiveDate": "2025-12-09T20:16:15.9862605-06:00",
      "locationName": "sample string 20",
      "dependantIndicator": "sample string 21",
      "criticalComment": "sample string 22",
      "identifier": "sample string 23",
      "diabetic": true,
      "isHospice": true,
      "nonCodedAllergies": "sample string 25",
      "sentToPharmacy": true,
      "cardholderID": "sample string 26",
      "secondaryCoverageOnly": true,
      "locked": true,
      "coverageLevelCode": "CHD - Children Only",
      "yearlyHouseholdIncome": 1.0,
      "isMDCaresPatient": true,
      "personCode": "sample string 27",
      "cobra": true,
      "isTestMember": true,
      "ignoreMemberInfoInClaims": true,
      "setMemberInfoNextClaim": true,
      "roomNumber": "sample string 31",
      "bedNumber": "sample string 32",
      "admittedDate": "2025-12-09T20:16:15.9862605-06:00",
      "dischargeDate": "2025-12-09T20:16:15.9862605-06: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-12-09T20:16:15.9862605-06:00",
        "effectiveEndDate": "2025-12-09T20:16:15.9862605-06:00",
        "patientPlanID": 5
      },
      "homeAddress": {
        "addressType": "Business",
        "address": "sample string 1",
        "addressLineTwo": "sample string 2",
        "city": "sample string 3",
        "stateCode": "sample string 4",
        "zipCode": "sample string 5",
        "country": "sample string 6"
      },
      "mailingAddress": {
        "addressType": "Business",
        "address": "sample string 1",
        "addressLineTwo": "sample string 2",
        "city": "sample string 3",
        "stateCode": "sample string 4",
        "zipCode": "sample string 5",
        "country": "sample string 6"
      },
      "clientID": "sample string 34",
      "externalID": "sample string 35",
      "currentFormulary": {
        "url": "sample string 2",
        "id": 3,
        "name": "sample string 1"
      },
      "nextFuturePlan": {
        "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-12-09T20:16:15.9862605-06:00",
        "effectiveEndDate": "2025-12-09T20:16:15.9862605-06:00",
        "patientPlanID": 5
      }
    },
    {
      "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-12-09T20:16:15.9862605-06:00",
      "comment": "sample string 12",
      "birthPlace": "sample string 13",
      "occupation": "sample string 14",
      "usCitizen": true,
      "military": true,
      "active": 15,
      "memberComment": "sample string 16",
      "hasMedicare": true,
      "medicareID": "sample string 18",
      "medicarePlan": "sample string 19",
      "medicareEffectiveDate": "2025-12-09T20:16:15.9862605-06:00",
      "locationName": "sample string 20",
      "dependantIndicator": "sample string 21",
      "criticalComment": "sample string 22",
      "identifier": "sample string 23",
      "diabetic": true,
      "isHospice": true,
      "nonCodedAllergies": "sample string 25",
      "sentToPharmacy": true,
      "cardholderID": "sample string 26",
      "secondaryCoverageOnly": true,
      "locked": true,
      "coverageLevelCode": "CHD - Children Only",
      "yearlyHouseholdIncome": 1.0,
      "isMDCaresPatient": true,
      "personCode": "sample string 27",
      "cobra": true,
      "isTestMember": true,
      "ignoreMemberInfoInClaims": true,
      "setMemberInfoNextClaim": true,
      "roomNumber": "sample string 31",
      "bedNumber": "sample string 32",
      "admittedDate": "2025-12-09T20:16:15.9862605-06:00",
      "dischargeDate": "2025-12-09T20:16:15.9862605-06: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-12-09T20:16:15.9862605-06:00",
        "effectiveEndDate": "2025-12-09T20:16:15.9862605-06:00",
        "patientPlanID": 5
      },
      "homeAddress": {
        "addressType": "Business",
        "address": "sample string 1",
        "addressLineTwo": "sample string 2",
        "city": "sample string 3",
        "stateCode": "sample string 4",
        "zipCode": "sample string 5",
        "country": "sample string 6"
      },
      "mailingAddress": {
        "addressType": "Business",
        "address": "sample string 1",
        "addressLineTwo": "sample string 2",
        "city": "sample string 3",
        "stateCode": "sample string 4",
        "zipCode": "sample string 5",
        "country": "sample string 6"
      },
      "clientID": "sample string 34",
      "externalID": "sample string 35",
      "currentFormulary": {
        "url": "sample string 2",
        "id": 3,
        "name": "sample string 1"
      },
      "nextFuturePlan": {
        "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-12-09T20:16:15.9862605-06:00",
        "effectiveEndDate": "2025-12-09T20:16:15.9862605-06:00",
        "patientPlanID": 5
      }
    }
  ],
  "totalRecordCount": 4
}