Skip to main content

Get Users List

Retrieve the list of patients associated with the designated facilities by utilizing the facilityId provided in the parameters and confirming the presence of a valid token in the headers.

Demo Curl​

curl --location 'https://demo.hng.one/developerapi/mmu/users?facilityId="<<Facility Id>>"' \
--header 'Authorization: Bearer <<Token>>'

Prod Curl​

curl --location 'https://aths.hng.one/developerapi/mmu/users?facilityId=<<Facility Id>>' \
--header 'Authorization: Bearer <<Token>>'

Sample Responce​

You will receive a response similar to below.

{
    "code": "Ok",
    "message": "Patient List obtained successfully",
    "data": [
        {
            "appId": "test client",
            "appUserId": "abcdefhhi12345",
            "appUserDisplayId": "90234hiewrkf",
            "appUserInfo": {
                "title": "Ms.",
                "firstName": "Patient",
                "lastName": "test",
                "middleName": "",
                "fullName": "Patient test",
                "name": "Patient test",
                "age": 22,
                "dobInEpoch": 994185000,
                "gender": "female",
                "mobileNumber": "1234567890",
                "altMobileNumber": "",
                "city": "hyd",
                "heightInCm": "",
                "weightInKg": "",
                "bloodGroup": "",
                "personalInfo": {
                    "relationType": "",
                    "relativeName": "",
                    "mothersName": "",
                    "religion": "",
                    "caste": "",
                    "maritalStatus": "",
                    "occupation": null,
                    "education": null
                },
                "citizenship": "INDIAN",
                "incomeGroup": "",
                "identificationDetails": {
                    "aadharNumber": null,
                    "addressProof": "No ID Proof Available",
                    "addressProofNumber": ""
                },
                "temporaryAddress": {
                    "address": "hyd",
                    "pincode": "hyd",
                    "state": "hyd",
                    "location": "hyd"
                },
                "isCurrentAddressPermanent": true,
                "permanentAddress": {
                    "address": "hyd",
                    "pincode": "hyd",
                    "state": "hyd",
                    "location": "hyd"
                },
                "priorityCase": false,
                "registeredAt": 1709559536,
                "communication": {
                    "emailId": ""
                }
            },
            "facilities": [
                {
                    "facilityId": "medex_facility|98734rghk",
                    "facilityName": "test"
                }
            ],
            "medexUID": "medexUID|8389dffdv",
            "metaInfo": {
                "createdAt": 1709559536,
                "createdBy": "auth0|12345",
                "updatedAt": 1709559536,
                "updatedBy": "auth0|12345"
            }
        }
    ]
}