Skip to content

Get all

GET

/:tenantId/patient-groups

Query parameters

NameTypeDescription
searchstringSearches by patient group name

Response

json
{
  "data": [
    {
      "id": 1,
      "name": "quis",
      "patients_count": 0
    },
    {
      "id": 2,
      "name": "aliquam",
      "patients_count": 0
    },
    {
      "id": 3,
      "name": "veniam",
      "patients_count": 0
    },
    {
      "id": 4,
      "name": "amet",
      "patients_count": 0
    },
    {
      "id": 5,
      "name": "dolorum",
      "patients_count": 0
    },
    {
      "id": 6,
      "name": "soluta",
      "patients_count": 0
    },
    {
      "id": 7,
      "name": "aliquam",
      "patients_count": 0
    },
    {
      "id": 8,
      "name": "porro",
      "patients_count": 0
    },
    {
      "id": 9,
      "name": "corporis",
      "patients_count": 0
    },
    {
      "id": 10,
      "name": "enim",
      "patients_count": 0
    }
  ],
  "links": {
    "first": "https://<Base URL>/api/v1/:tenantId/patient-groups?page=1",
    "last": "https://<Base URL>/api/v1/:tenantId/patient-groups?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/patient-groups?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "pagination.next",
        "active": false
      }
    ],
    "path": "https://<Base URL>/api/v1/:tenantId/patient-groups",
    "per_page": 15,
    "to": 10,
    "total": 10
  }
}