- Auth
- ForgotPassword
- Profile
- Family Members
- Address
- Languages
- Products
- Permissions
- Config
- Appointment Schedule
- Test Tags
- Test Parameters
- Category
- Device
- File
- Appointment
- Reports
- Staff
- Patient
- Notifications
List Patients
Developing
GET
/api/service/v1/user/patients
Request
Query Params
page_no
string
optional
Example:
1
page_size
string
optional
Example:
10
keyword
string
optional
Example:
deep
Header Params
Accept
string
optional
Example:
application/json
Content-Type
string
optional
Example:
application/json
practice-code
string
optional
Example:
DEFAULT
Authorization
string
optional
Example:
{{token}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://afyahealth.doctodoor.com:5600/api/service/v1/user/patients?page_no=1&page_size=10&keyword=deep' \
--header 'Accept: application/json' \
--header 'practice-code: DEFAULT' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImVtYWlsIjoiZGVlcC5tYXJzb25pYUBwbGVuYXJ0ZWNoLmNvbSIsInN1YiI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImlhdCI6MTc0MTc4MjA4NCwiZXhwIjoxNzQ5NTU4MDg0fQ.KAMsweSbJPDxpLijKdjgp3YEFauw8KYLLumCBpqQfAA' \
--header 'Content-Type: application/json'Responses
🟢200Success
application/json
Body
error
boolean
required
status_code
integer
required
message
string
required
data
object
required
total
integer
required
patients
array [object {18}]
required
Example
{
"error": false,
"status_code": 200,
"message": "",
"data": {
"total": 5,
"patients": [
{
"roles": [
{
"practice": "677bb5bd4291b96cd0623e93",
"deleted_at": null,
"is_deleted": 0,
"name": "Patient",
"slug": "patient",
"created_at": "2025-01-06T10:51:41.295Z",
"updated_at": "2025-01-06T10:51:41.295Z",
"id": "677bb5bd4291b96cd0623e98"
}
],
"is_master_admin": 0,
"is_temporary_password": 0,
"is_deleted": 0,
"is_active": 1,
"deleted_at": null,
"language_code": "en",
"family_members": [],
"first_name": "Deep",
"full_name": "Deep undefined",
"email": "sfd33fdfl@gmail.com",
"phone_primary": "7766787898",
"country_code": "+91",
"created_at": "2025-01-23T10:23:52.211Z",
"updated_at": "2025-01-23T10:23:52.211Z",
"id": "679218b81c4f6665b1c0970c"
},
{
"roles": [
{
"practice": "677bb5bd4291b96cd0623e93",
"deleted_at": null,
"is_deleted": 0,
"name": "Patient",
"slug": "patient",
"created_at": "2025-01-06T10:51:41.295Z",
"updated_at": "2025-01-06T10:51:41.295Z",
"id": "677bb5bd4291b96cd0623e98"
}
],
"is_master_admin": 0,
"is_temporary_password": 0,
"is_deleted": 0,
"is_active": 1,
"deleted_at": null,
"language_code": "en",
"family_members": [],
"first_name": "Deep",
"full_name": "Deep undefined",
"email": "sfdfdfl@gmail.com",
"phone_primary": "7766787898",
"country_code": "+91",
"created_at": "2025-01-23T06:58:27.413Z",
"updated_at": "2025-01-23T06:58:27.413Z",
"id": "6791e893f104b548326dfa4f"
},
{
"roles": [
{
"practice": "677bb5bd4291b96cd0623e93",
"deleted_at": null,
"is_deleted": 0,
"name": "Patient",
"slug": "patient",
"created_at": "2025-01-06T10:51:41.295Z",
"updated_at": "2025-01-06T10:51:41.295Z",
"id": "677bb5bd4291b96cd0623e98"
}
],
"is_master_admin": 0,
"is_temporary_password": 0,
"is_deleted": 0,
"is_active": 1,
"deleted_at": null,
"language_code": "en",
"family_members": [],
"first_name": "Deep",
"full_name": "Deep undefined",
"email": "myemasdfdfl@gmail.com",
"phone_primary": "7766787898",
"country_code": "+91",
"created_at": "2025-01-23T06:57:53.210Z",
"updated_at": "2025-01-23T06:57:53.210Z",
"id": "6791e871830cd44806671743"
},
{
"roles": [
{
"practice": "677bb5bd4291b96cd0623e93",
"deleted_at": null,
"is_deleted": 0,
"name": "Patient",
"slug": "patient",
"created_at": "2025-01-06T10:51:41.295Z",
"updated_at": "2025-01-06T10:51:41.295Z",
"id": "677bb5bd4291b96cd0623e98"
}
],
"is_master_admin": 0,
"is_temporary_password": 0,
"is_deleted": 0,
"is_active": 1,
"deleted_at": null,
"language_code": "en",
"family_members": [],
"first_name": "Deep",
"full_name": "Deep undefined",
"email": "myemassadasasil@gmail.com",
"phone_primary": "7766787898",
"country_code": "+91",
"created_at": "2025-01-23T06:56:55.674Z",
"updated_at": "2025-01-23T06:56:55.674Z",
"id": "6791e837a9a00547a5b592ba"
},
{
"roles": [
{
"practice": "677bb5bd4291b96cd0623e93",
"deleted_at": null,
"is_deleted": 0,
"name": "Patient",
"slug": "patient",
"created_at": "2025-01-06T10:51:41.295Z",
"updated_at": "2025-01-06T10:51:41.295Z",
"id": "677bb5bd4291b96cd0623e98"
}
],
"is_master_admin": 1,
"is_temporary_password": 0,
"is_deleted": 0,
"is_active": 1,
"deleted_at": null,
"language_code": "en",
"first_name": "Deep",
"middle_name": "",
"last_name": "Marsonia",
"full_name": "Deep Marsonia",
"email": "deep.marsonia+pt1@plenartech.com",
"created_at": "2025-01-06T10:51:41.453Z",
"updated_at": "2025-01-06T10:51:41.453Z",
"family_members": [],
"id": "677bb5bd4291b96cd0623eee"
}
]
}
}