> ## 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. # Get IPD Setup Data > ### Overview This API returns your workspace's **IPD setup data in one call**: beds, rooms, categories, rate plans, rate plan inclusions, and the bed and rate plan links to clinics. Only active (not deleted) items are returned. Both query parameters are optional: - `keys` — comma-separated list of the collections to return (for example `beds,rooms`). Unknown keys are ignored. When omitted, all collections are returned. - `from` — return only items updated after this date-time, to sync changes since your last call. > **Deletions are not returned.** Deleted items are left out of every response, including with `from`. To detect deletions, compare against a full fetch without `from`. ## OpenAPI ````yaml get /ipd/v1/service/ipd 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: /ipd/v1/service/ipd: get: tags: - IPD API summary: Get IPD Setup Data description: >- ### Overview This API returns your workspace's **IPD setup data in one call**: beds, rooms, categories, rate plans, rate plan inclusions, and the bed and rate plan links to clinics. Only active (not deleted) items are returned. Both query parameters are optional: - `keys` — comma-separated list of the collections to return (for example `beds,rooms`). Unknown keys are ignored. When omitted, all collections are returned. - `from` — return only items updated after this date-time, to sync changes since your last call. > **Deletions are not returned.** Deleted items are left out of every response, including with `from`. To detect deletions, compare against a full fetch without `from`. operationId: GetIpdSetupData parameters: - name: auth in: header required: true schema: type: string example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM - name: keys in: query description: >- Comma-separated collections to return: `beds`, `bedclinicrelations`, `rooms`, `categories`, `rateplans`, `rateplaninclusions`, `rateplanclinicrelations`. All when omitted. required: false schema: type: string example: beds,rooms,categories - name: from in: query description: Only items updated after this date-time (ISO-8601). required: false schema: type: string example: '2026-10-01T00:00:00.000Z' responses: '200': description: >- OK — the requested setup data. Only the requested collections are present. content: application/json: schema: type: object properties: success: type: boolean data: type: object properties: beds: type: array items: $ref: '#/components/schemas/IpdBed' bedclinicrelations: type: array items: $ref: '#/components/schemas/IpdBedClinicRelation' rooms: type: array items: $ref: '#/components/schemas/IpdRoom' categories: type: array items: $ref: '#/components/schemas/IpdCategory' rateplans: type: array items: $ref: '#/components/schemas/IpdRatePlan' rateplaninclusions: type: array items: $ref: '#/components/schemas/IpdRatePlanInclusion' rateplanclinicrelations: type: array items: $ref: '#/components/schemas/IpdRatePlanClinicRelation' example: success: true data: beds: - id: 66f1c4d2e4b0a1b2c3d4e702 name: ICU-04 room: 66f1c3b7e4b0a1b2c3d4e601 updatedAt: '2026-10-07T09:50:00.000Z' rooms: - id: 66f1c3b7e4b0a1b2c3d4e601 name: ICU Room 1 category: 66f1c2a9e4b0a1b2c3d4e5f6 updatedAt: '2026-10-07T09:45:00.000Z' categories: - id: 66f1c2a9e4b0a1b2c3d4e5f6 name: ICU description: Intensive Care Unit updatedAt: '2026-10-07T09:30:00.000Z' '400': description: >- Bad Request — the data could not be loaded (for example `from` is not a valid date). content: application/json: schema: $ref: '#/components/schemas/IpdServiceFailure' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/IpdServiceError' deprecated: false components: schemas: IpdBed: title: IpdBed type: object properties: id: type: string description: Bed id. name: type: string description: Display name of the bed. room: type: string description: Id of the room the bed belongs to. Absent when not set. updatedAt: type: string description: Last-updated date-time as an ISO-8601 string. IpdBedClinicRelation: title: IpdBedClinicRelation type: object properties: id: type: string description: Bed-clinic link id. bed: type: string description: Id of the linked bed. clinic_id: type: string description: Id of the linked clinic. archived: type: boolean description: '`true` when the link has been removed.' updatedAt: type: string description: Last-updated date-time as an ISO-8601 string. IpdRoom: title: IpdRoom type: object properties: id: type: string description: Room id. name: type: string description: Display name of the room. category: type: string description: Id of the category the room belongs to. Absent when not set. updatedAt: type: string description: Last-updated date-time as an ISO-8601 string. IpdCategory: title: IpdCategory type: object properties: id: type: string description: Category id. name: type: string description: Display name of the category. description: type: string description: Free-text description of the category. Absent when not set. updatedAt: type: string description: Last-updated date-time as an ISO-8601 string. IpdRatePlan: title: IpdRatePlan type: object properties: id: type: string description: Rate plan id. name: type: string description: Display name of the rate plan. updatedAt: type: string description: Last-updated date-time as an ISO-8601 string. IpdRatePlanInclusion: title: IpdRatePlanInclusion type: object properties: id: type: string description: Inclusion id. plan: type: string description: Id of the rate plan the inclusion belongs to. name: type: string description: Display name of the inclusion. rate: type: number description: Rate (amount) of the inclusion. updatedAt: type: string description: Last-updated date-time as an ISO-8601 string. IpdRatePlanClinicRelation: title: IpdRatePlanClinicRelation type: object properties: id: type: string description: Rate plan-clinic link id. plan: type: string description: Id of the linked rate plan. clinic_id: type: string description: Id of the linked clinic. archived: type: boolean description: '`true` when the link has been removed.' updatedAt: type: string description: Last-updated date-time as an ISO-8601 string. IpdServiceFailure: title: IpdServiceFailure type: object properties: success: type: boolean description: Always `false`. error: type: string description: Human-readable error message. IpdServiceError: title: IpdServiceError type: object properties: message: type: string description: Human-readable error message. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.