v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

HIP Users API

List Eka Users

Overview

Retrieve a list of all Eka Users (HIP Users) registered for your business. Each entry includes the user's profile, role, seat type, and the doctors and clinics they are associated with.

Endpoint: {{HOST}}/cdr/v1/ekauser

Method: GET

Response Parameters

Parameter	Type	Description
status	string	Status of the response (e.g., "success")
users	array	List of Eka User objects belonging to the business

get/cdr/v1/ekauser/

Headers

authstring required

Example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM

The auth token of the business. It is used to authenticate the client. This should be fetched from auth api.

Response

OK - List of Eka Users

statusstring

Example response

{
  "status": "success",
  "users": [
    {
      "id": "176917697553584",
      "firstname": "Amit",
      "lastname": "Kumar",
      "mobile": "+919876543210",
      "email": "amit.kumar@example.com",
      "seat_type": "b",
      "doctors": [
        {
          "id": "do1769174683513",
          "firstname": "Rajesh",
          "lastname": "Sharma"
        }
      ],
      "clinics": [
        {
          "id": "c-ab2c-34f2d-2gwd-2g2g",
          "name": "Sunrise Clinic"
        }
      ],
      "partner_id": "Part_user_1"
    }
  ]
}