Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Patient

List patient profiles

Retrieves a paginated list of patient profiles.

The following fields are always included in the response, regardless of the select parameter:

  • mobile
  • oid
  • username
  • fln
get/profiles/v1/patient/minified/

Query parameters

pageNointeger required
Example:1
pageSizeinteger
Example:100

The number of records to return. Default is 500. Maximum is 2000.

selectstring

Comma-separated list of additional fields to include in the response. Example: abha,dob,gen

Valid optional fields: abha, c_ate, dob, gen, u_ate

frominteger

Get profiles created after this time Format: epoch timestamp Example: 1750745358

arcboolean

Include archived profiles in the response. Default is false. Set to true to include archived profiles. Setting this to true will also include arc field in the response wherever applicable.

Headers

client-idstring required
Example:EC_1431

Response

A list of patient profiles

Example response

{
  "profiles": [
    {
      "mobile": "1212121212",
      "fln": "Test user",
      "u_ate": 1750918049,
      "c_ate": 1750918049,
      "dob": "2000-01-02",
      "gen": "M",
      "oid": "175074536120088",
      "wid": "77088111111111"
    }
  ],
  "currPageMeta": {
    "currPageNo": 1,
    "pageSize": 10,
    "nextPage": 2
  }
}