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

> 
### Overview

This API returns how IPD case numbers (IPIDs) are generated for your workspace: the `prefix`, the running number `startsFrom`, and two settings for the admission form.

`startsFrom` is the **last number used**: the next generated IPID is `prefix` + (`startsFrom` + 1). A workspace that has never set the config returns the defaults (`prefix: IPD`, `startsFrom: 1`, both settings `false`).



## OpenAPI

````yaml get /ipd/v1/service/admissions/ipid-config
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/admissions/ipid-config:
    get:
      tags:
        - IPD API
      summary: Get IPID Config
      description: >-

        ### Overview


        This API returns how IPD case numbers (IPIDs) are generated for your
        workspace: the `prefix`, the running number `startsFrom`, and two
        settings for the admission form.


        `startsFrom` is the **last number used**: the next generated IPID is
        `prefix` + (`startsFrom` + 1). A workspace that has never set the config
        returns the defaults (`prefix: IPD`, `startsFrom: 1`, both settings
        `false`).
      operationId: GetIpdIpidConfig
      parameters:
        - name: auth
          in: header
          required: true
          schema:
            type: string
          example: >-
            eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM
      responses:
        '200':
          description: OK — the IPID config.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpdIpidConfigResponse'
              example:
                success: true
                data:
                  owner: '170142612985588'
                  prefix: IPD
                  startsFrom: 1044
                  editable_in_admission: false
                  auto_generate_in_admission: true
        '400':
          description: Bad Request — the config could not be loaded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpdServiceFailure'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpdServiceError'
      deprecated: false
components:
  schemas:
    IpdIpidConfigResponse:
      title: IpdIpidConfigResponse
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            owner:
              type: string
              description: Workspace id.
            prefix:
              type: string
              description: Text placed before the running number.
            startsFrom:
              type: integer
              description: Last number used. The next IPID uses `startsFrom + 1`.
            editable_in_admission:
              type: boolean
              description: Whether the IPID can be edited on the admission form.
            auto_generate_in_admission:
              type: boolean
              description: >-
                Whether the IPID is generated automatically on the admission
                form.
    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.