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

# List Saved IRMs

> Read a platform customer's already-fetched inward remittances (IRMs) from your account without a live refresh, with pagination for reviewing saved records.

Return the customer's IRMs from your account's saved data, without a live refresh. Use this for everyday reads and pagination; run [Fetch IRM List](/api-reference/irm/post) first, and again whenever you want fresh data.

### Request example

```bash theme={"dark"}
curl --location 'https://ebrcapi.eximfiles.io/api/v1/irm?platformCustomerId=ee849a90-7a28-49b4-8cb2-8e31041650a2&page=1&limit=10' \
  --header 'x-api-key: <YOUR_API_KEY>'
```

Optional filters: `irmNumber`, `fromDate`, `toDate` (ISO dates), and `page` / `limit` for pagination.

### Response

Same paginated shape as [Fetch IRM List](/api-reference/irm/post): an IRM array in `data.data` plus a `meta` block with `total`, `page`, `limit`, and `totalPages`, wrapped in the [standard envelope](/api-reference/introduction#response-envelope).

### Next steps

* [Fetch IRM List](/api-reference/irm/post) to refresh the live data first.
* [Submit IRMs for generation](/api-reference/genebrc/push-irm).
* [Download IRMs as Excel](/api-reference/irm/bulk-template).


## OpenAPI

````yaml GET /irm
openapi: 3.1.0
info:
  title: eBRC API
  description: >-
    REST API for generating and managing electronic Bank Realization
    Certificates (eBRC) through DGFT's GenEBRC module. Onboard exporters,
    validate their DGFT credentials, pull inward remittance (IRM) data, submit
    certificate generation requests singly or in bulk, and track them to
    completion. All JSON responses are wrapped in the standard envelope {
    success, data, statusCode, timestamp }; the schemas on each endpoint
    describe the data field.
  contact:
    name: Eximfiles support
    email: amin@eximfiles.io
  version: 1.0.0
servers:
  - url: https://ebrcapi.eximfiles.io/api/v1
    description: Production
  - url: https://ebrcapi.dev.eximfiles.com/api/v1
    description: Sandbox
security:
  - x-api-key: []
paths:
  /irm:
    get:
      summary: List saved IRMs
      description: >-
        Return the platform customer's saved IRMs without contacting DGFT. Use
        POST /irm/refresh first to pull fresh data from DGFT; use this endpoint
        for subsequent reads.
      operationId: listIrms
      parameters:
        - name: platformCustomerId
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Paginated IRMs after refresh
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/IRM'
                  meta:
                    type: object
                    properties:
                      total:
                        type: integer
                      page:
                        type: integer
                      limit:
                        type: integer
                      totalPages:
                        type: integer
components:
  schemas:
    IRM:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier (UUID)
        irmNumber:
          type: string
        irmIssueDate:
          type: string
        irmStatus:
          type: string
          enum:
            - fresh
            - amended
            - pending_amendment
            - canceled
            - ready_for_processing
        ifscCode:
          type: string
        remittanceAdCode:
          type: string
        remittanceDate:
          type: string
        remittanceFCC:
          type: string
        remittanceFCCAmount:
          type: number
        ormAmountFCC:
          type: number
        irmAvailableAmt:
          type: number
        irmUtilizedAmt:
          type: number
        iecCode:
          type: string
        panNumber:
          type: string
        remitterName:
          type: string
        remitterCountry:
          type: string
        purposeOfRemittance:
          type: string
          nullable: true
        subjectType:
          type: string
          enum:
            - USER
            - PLATFORM_CUSTOMER
        userId:
          type: string
          nullable: true
        platformCustomerId:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header

````