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

> Lists your workspace's IPD admissions, optionally filtered. Archived admissions are excluded unless `include_archived=true`.



## OpenAPI

````yaml api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions
openapi: 3.1.0
info:
  title: Eka IPD Admission API
  version: '1.0'
servers:
  - description: Production
    url: https://api.eka.care
  - description: Stage/Sandbox
    url: https://api.dev.eka.care
security: []
paths:
  /ipd/v1/sdk/admissions:
    get:
      tags:
        - IPD API
      summary: List IPD admissions
      description: >-
        Lists your workspace's IPD admissions, optionally filtered. Archived
        admissions are excluded unless `include_archived=true`.
      operationId: IpdSdkListIpdAdmissions
      parameters:
        - name: auth
          in: header
          required: true
          schema:
            type: string
          example: >-
            eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM
        - schema:
            anyOf:
              - type: string
                enum:
                  - IN
              - type: string
                enum:
                  - AD
              - type: string
                enum:
                  - DC
          in: query
          name: stage
          required: false
          description: Only admissions in this stage (`IN`/`AD`/`DC`).
        - schema:
            minLength: 1
            type: string
          in: query
          name: pid
          required: false
          description: Only this patient's admissions.
        - schema:
            minLength: 1
            type: string
          in: query
          name: ipid
          required: false
          description: Only admissions with this IPD case number.
        - schema:
            minLength: 1
            type: string
          in: query
          name: pending_pharmacy_provider
          required: false
          description: >-
            Only admissions still waiting on this pharmacy provider (for example
            `dawakhana`) to close its dues.
        - schema:
            type: string
          in: query
          name: discharge_date_start
          required: false
          description: Inclusive lower bound on `discharge_date` (ISO date-time).
        - schema:
            type: string
          in: query
          name: discharge_date_end
          required: false
          description: Inclusive upper bound on `discharge_date` (ISO date-time).
        - schema:
            type: boolean
          in: query
          name: include_archived
          required: false
          description: Include archived admissions. Defaults to `false`.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  additionalProperties: true
                  type: object
                  properties:
                    id:
                      type: string
                    bid:
                      type: string
                    admission_date:
                      description: ISO date-time.
                      type: string
                    discharge_date:
                      type: string
                    ipid:
                      description: Patient IPD case number.
                      type: string
                    attendee:
                      additionalProperties: true
                      type: object
                      required:
                        - id
                        - name
                        - phone
                        - relation
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        phone:
                          additionalProperties: true
                          type: object
                          properties:
                            c:
                              type: string
                            'n':
                              type: string
                        relation:
                          additionalProperties: true
                          type: object
                          required:
                            - id
                            - label
                          properties:
                            id:
                              type: string
                            label:
                              type: string
                    patient:
                      additionalProperties: true
                      type: object
                      required:
                        - id
                        - uuid
                        - poid
                        - formData
                        - profile
                      properties:
                        id:
                          type: string
                        uuid:
                          type: string
                        poid:
                          type: string
                        formData:
                          type: array
                          items:
                            additionalProperties: true
                            type: object
                            required:
                              - label
                              - type
                              - key
                              - value
                            properties:
                              label:
                                type: string
                              type:
                                type: string
                              key:
                                type: string
                              value:
                                anyOf:
                                  - type: string
                                  - type: number
                                  - type: array
                                    items:
                                      type: string
                        profile:
                          additionalProperties: true
                          type: object
                          required:
                            - personal
                          properties:
                            personal:
                              additionalProperties: true
                              type: object
                              required:
                                - gender
                                - name
                              properties:
                                gender:
                                  type: string
                                name:
                                  type: string
                                phone:
                                  additionalProperties: true
                                  type: object
                                  properties:
                                    c:
                                      type: string
                                    'n':
                                      type: string
                                age:
                                  additionalProperties: true
                                  type: object
                                  properties:
                                    dob:
                                      type: string
                                    value:
                                      type: string
                                    month:
                                      type: string
                    procedures:
                      type: array
                      items:
                        additionalProperties: true
                        type: object
                        required:
                          - id
                          - name
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                          date:
                            type: string
                          notes:
                            type: string
                    refer:
                      type: object
                      required:
                        - id
                        - name
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                    doc:
                      type: object
                      required:
                        - id
                        - name
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                    notes:
                      type: string
                    medico_legal_case:
                      type: boolean
                    stage:
                      description: >-
                        Coarse lifecycle stage (`IN`/`AD`/`DC`) — replaced the
                        legacy coarse `status`.
                      anyOf:
                        - type: string
                          enum:
                            - IN
                        - type: string
                          enum:
                            - AD
                        - type: string
                          enum:
                            - DC
                    status:
                      description: Granular lifecycle status within the current `stage`.
                      anyOf:
                        - type: string
                          enum:
                            - ADMISSION_RECOMMENDED
                        - type: string
                          enum:
                            - ADMISSION_ON_HOLD
                        - type: string
                          enum:
                            - ADMISSION_CONFIRMED
                        - type: string
                          enum:
                            - ADMISSION_CANCELLED
                        - type: string
                          enum:
                            - BED_ASSIGNED
                        - type: string
                          enum:
                            - UNDER_CARE
                        - type: string
                          enum:
                            - NOT_RECEIVED
                        - type: string
                          enum:
                            - FIT_FOR_DISCHARGE
                        - type: string
                          enum:
                            - DISCHARGE_INITIATED
                        - type: string
                          enum:
                            - REFERRAL_INITIATED
                        - type: string
                          enum:
                            - LAMA_IN_PROGRESS
                        - type: string
                          enum:
                            - DAMA_IN_PROGRESS
                        - type: string
                          enum:
                            - DEATH_BEING_RECORDED
                        - type: string
                          enum:
                            - PATIENT_MISSING
                        - type: string
                          enum:
                            - DISCHARGED
                        - type: string
                          enum:
                            - LAMA_COMPLETED
                        - type: string
                          enum:
                            - DAMA_COMPLETED
                        - type: string
                          enum:
                            - REFERRED
                        - type: string
                          enum:
                            - DECEASED
                        - type: string
                          enum:
                            - ABSCONDED
                    duration:
                      additionalProperties: true
                      type: object
                      required:
                        - value
                        - unit
                      properties:
                        value:
                          type: number
                        unit:
                          type: string
                    bed:
                      type: string
                    rateplan:
                      additionalProperties: true
                      type: object
                      required:
                        - id
                        - name
                        - inclusions
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        inclusions:
                          type: array
                          items:
                            additionalProperties: true
                            type: object
                            required:
                              - id
                              - name
                              - rate
                            properties:
                              id:
                                type: string
                              name:
                                type: string
                              rate:
                                type: number
                    docid:
                      type: string
                    category:
                      type: object
                      required:
                        - id
                        - name
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                    date:
                      type: string
                    department:
                      type: object
                      required:
                        - id
                        - name
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                    pid:
                      type: string
                    created_at:
                      type: string
                    updated_at:
                      type: string
                    facility:
                      type: object
                      required:
                        - id
                        - name
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                    facilityid:
                      type: string
                    totalbilled:
                      type: number
                    totalpaid:
                      type: number
                    totalbilled_updated_at:
                      type: string
                    totalpaid_updated_at:
                      type: string
                    custom_attributes:
                      type: object
                      additionalProperties:
                        type: array
                        items:
                          type: string
                    clearances_summary:
                      additionalProperties: true
                      type: object
                      required:
                        - statuses
                        - completed_count
                        - total
                        - all_complete
                      properties:
                        statuses:
                          type: object
                          additionalProperties:
                            anyOf:
                              - type: string
                                enum:
                                  - PENDING
                              - type: string
                                enum:
                                  - COMPLETED
                        completed_count:
                          type: number
                        total:
                          type: number
                        all_complete:
                          type: boolean
                    archived:
                      type: boolean
                    actor_oid:
                      type: string
                  title: LenientAdmission
        '400':
          description: Bad Request — the request failed validation or was rejected.
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.