Skip to main content
GET
/
v1
/
organisations
/
{organisationId}
/
clients
List clients
curl --request GET \
  --url https://api.halth.com/v1/organisations/{organisationId}/clients
{
  "items": [
    {
      "id": "<string>",
      "deleted": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "firstName": "<string>",
      "lastName": "<string>",
      "dateOfBirth": "<string>",
      "mobileNumber": "<string>",
      "email": "<string>",
      "source": "pms",
      "pmsPatientId": "<string>",
      "pmsCreatedAt": "2023-11-07T05:31:56Z",
      "profileImageUrl": "<string>"
    }
  ],
  "page": 1,
  "limit": 10,
  "totalItems": 100,
  "totalPages": 10
}

Path Parameters

organisationId
string
required

Query Parameters

page
number
default:1

Page number

Required range: 1 <= x <= 9007199254740991
Example:

1

limit
number
default:10

Number of items per page

Required range: 1 <= x <= 200
Example:

10

q
string

Response

200 - application/json
items
object[]
page
number
Example:

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10