v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

HIP Users API

Get Eka User by ID

Overview

Retrieve a single Eka User's profile using either the Eka ID or the partner-provided ID.

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

Method: GET

Path Parameters

Parameter	Type	Description	Required
user_id	string	Eka User's Eka ID or partner-provided ID	Yes

get/cdr/v1/ekauser/{user_id}/

Path parameters

user_idstring required

Example:176917697553584

Eka User's Eka ID or partner-provided ID

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 - Eka User details retrieved

statusstring

Example response

{
  "status": "success",
  "user": {
    "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"
  }
}