> ## Documentation Index
> Fetch the complete documentation index at: https://developer.eka.care/llms.txt
> Use this file to discover all available pages before exploring further.

# 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         |



## OpenAPI

````yaml get /cdr/v1/ekauser/
openapi: 3.0.0
info:
  title: Ekacare API & Webhook Documentation
  contact: {}
  version: '1.0'
servers:
  - description: Production
    url: https://api.eka.care
  - description: Stage/Sandbox
    url: https://api.dev.eka.care
security: []
paths:
  /cdr/v1/ekauser/:
    get:
      tags:
        - HIP Users API
      summary: List Eka Users
      description: >-
        ### 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         |
      operationId: ListEkaUsers
      parameters:
        - name: auth
          in: header
          description: >-
            The auth token of the business. It is used to authenticate the
            client. This should be fetched from auth api.
          required: true
          style: simple
          schema:
            type: string
            example: >-
              eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM
      responses:
        '200':
          description: OK - List of Eka Users
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: '176917697553584'
                        firstname:
                          type: string
                          example: Amit
                        lastname:
                          type: string
                          example: Kumar
                        mobile:
                          type: string
                          example: '+919876543210'
                        email:
                          type: string
                          example: amit.kumar@example.com
                        is_admin:
                          type: boolean
                          example: false
                        seat_type:
                          type: string
                          description: Seat type (b - basic, p - premium)
                          example: b
                        doctors:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: do1769174683513
                              firstname:
                                type: string
                                example: Rajesh
                              lastname:
                                type: string
                                example: Sharma
                        clinics:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: c-ab2c-34f2d-2gwd-2g2g
                              name:
                                type: string
                                example: Sunrise Clinic
                        partner_id:
                          type: string
                          example: Part_user_1
        '400':
          description: Bad Request - Business could not be resolved from auth token

````