Health Grid / Patient
/v3/health/grid/patient endpoint reference.
URL: https://demo.1health.io/api/v3/health/grid/patient
No description available in the API specification.
Endpoints
| Endpoint | Method | Description |
|---|---|---|
| /v3/health/grid/patient | POST | List Patients |
POST/v3/health/grid/patient
List Patients
Overview
Retrieve a paginated list of patients with optional filtering and sorting.
Authorization
Bearer JWT required. See the authentication guide.
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| page | int | No | 0 | Page number (0-indexed) |
| size | int | No | 50 | Number of items per page |
| includeLabelTags | boolean | No | false | Whether to include label tags in the response |
Request Body
Content-Type: application/json · DTO: RootDataRequest
{
"filterBy": "example-value",
"orderBy": "example-value"
}
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
| filterBy | array | No | List of filter conditions to apply to the grid data. Each filter specifies: |
- key: The column/field to filter on
- operator: The comparison operator (equals, contains, greaterThan, etc.)
- value: The value to filter by
All filters are combined with AND logic. For multiple OR conditions, use the 'in' operator. | | orderBy | array | No | | List of sort conditions to apply to the grid data. Each sort specifies:
- key: The column/field to sort by
- order: Sort direction (ASC or DESC)
- priority: Optional sort priority for multi-column sorting
Lower priority numbers are applied first. |
Responses
200 OK
Paginated list of patients
DTO: Page
{
"data": [
{}
],
"pageNumber": "example-value",
"pageSize": "example-value",
"offset": 1001,
"emptyPage": true,
"firstPage": true,
"lastPage": true,
"numberOfElements": 1001,
"totalElements": 1001,
"totalPages": "example-value"
}
| Field | Type | Nullable | Description |
|---|---|---|---|
| data | List | No | |
| pageNumber | integer | No | |
| pageSize | integer | No | |
| offset | long | No | |
| emptyPage | boolean | No | |
| firstPage | boolean | No | |
| lastPage | boolean | No | |
| numberOfElements | long | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Example
curl -X POST "https://demo.1health.io/api/v3/health/grid/patient" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" -d '{"filterBy": "example-value", "orderBy": "example-value"}'
Navigation
Parent: https://agents.1health.io/public/demo/api/v3/health/grid/agents.md · Site guide: https://agents.1health.io/public/demo/api/agents.md