Get All
GET
/:tenantId/patientsQuery Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter[birth_date][from] | datetime | no | Filters results by birth dates starting from this date (format: YYYY-MM-DD). |
filter[birth_date][to] | datetime | no | Filters results by birth dates up to this date (format: YYYY-MM-DD). |
filter[group_id] | integer | no | Filters results by group IDs. Accepts a comma-separated list of IDs (e.g., 1,2). |
filter[user_id] | integer | no | Filters by assigned user. |
filter[type] | integer | no | Filters by patient type. |
filter[control_date][from] | datetime | no | Filters by control date lower bound. |
filter[control_date][to] | datetime | no | Filters by control date upper bound. |
filter[created_at][from] | datetime | no | Filters by creation date using YYYY-MM-DD HH:mm. |
filter[created_at][to] | datetime | no | Filters by creation date using YYYY-MM-DD HH:mm. |
filter[age_range] | string | no | Filters by supported patient age range. |
filter[last_appointment] | date | no | Filters by last appointment date using YYYY-MM-DD. |
filter[mobile] | string | no | Exact mobile-number filter. |
filter[source] | string | no | Filters by source. |
filter[external_id] | string | no | Filters by external identifier. |
include | string | no | Use service_provider_names to include service provider names. |
search | string | no | Searches by name, mobile |
Response
HTTP 200 OK
json
{
"data": [
{
"id": 1,
"name": "John Doe",
"mobile": "+1234567890",
"emergency_contact_name": null,
"emergency_contact_phone": null,
"email": "johndoe@example.com",
"birth_date": "1980-01-01T00:00:00.000000Z",
"identity_number": "123456789",
"protocol_no": "JD123",
"photo": null,
"groups": [],
"sms_consent": 1,
"type": 1,
"created_at": "2026-01-01T10:00:00.000000Z"
},
{
"id": 2,
"name": "Jane Doe",
"mobile": "+9876543210",
"email": "janedoe@example.com",
"birth_date": "1990-02-02T00:00:00.000000Z",
"identity_number": "987654321",
"protocol_no": "JD456",
"photo": null,
"groups": [],
"sms_consent": 0
},
{
"id": 3,
"name": "Alice Smith",
"mobile": "+1122334455",
"email": "alice.smith@example.com",
"birth_date": "1995-03-03T00:00:00.000000Z",
"identity_number": "555666777",
"protocol_no": "AS789",
"photo": null,
"groups": [],
"sms_consent": 1
},
{
"id": 4,
"name": "Bob Johnson",
"mobile": "+9988776655",
"email": "bob.johnson@example.com",
"birth_date": "1985-04-04T00:00:00.000000Z",
"identity_number": "333444555",
"protocol_no": "BJ101",
"photo": null,
"groups": [],
"sms_consent": 2
},
{
"id": 5,
"name": "Charlie Brown",
"mobile": "+4455667788",
"email": "charlie.brown@example.com",
"birth_date": "2000-05-05T00:00:00.000000Z",
"identity_number": "111222333",
"protocol_no": "CB202",
"photo": null,
"groups": [],
"sms_consent": 1
}
],
"links": {
"first": "https://<Base URL>/api/v1/:tenantId/patients?page=1",
"last": "https://<Base URL>/api/v1/:tenantId/patients?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "pagination.previous",
"active": false
},
{
"url": "https://<Base URL>/api/v1/:tenantId/patients?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "pagination.next",
"active": false
}
],
"path": "https://<Base URL>/api/v1/:tenantId/patients",
"per_page": 5,
"to": 5,
"total": 5
}
}