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

# Get Customers List

> List the platform customers under your account with pagination and search by partial name or email, so you can find the exporter entity you generate eBRCs for.

List every exporter entity under your platform account. Use this to reconcile your records with the API or to look up a `platformCustomerId` you did not store.

### Request example

```bash theme={"dark"}
curl --location 'https://ebrcapi.eximfiles.io/api/v1/platform-customers?page=1&limit=10&search=surya' \
  --header 'x-api-key: <YOUR_API_KEY>'
```

`page` starts at 1; `limit` defaults to 10 and caps at 100; `search` filters by partial name or email.

### Response example

```json theme={"dark"}
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "ee849a90-7a28-49b4-8cb2-8e31041650a2",
        "name": "Rohan Mehta",
        "email": "finance@suryatextiles.example.com",
        "type": "customer",
        "companyName": "Surya Textile Exports Pvt Ltd",
        "address": "Tiruppur, Tamil Nadu",
        "platformId": "1f0c9a52-3b41-4d78-9e26-7a8b5c4d3e2f",
        "isActive": true,
        "createdAt": "2026-07-22T10:15:04.874Z",
        "updatedAt": "2026-07-22T10:21:33.120Z"
      }
    ],
    "meta": {
      "totalItems": 1,
      "itemsPerPage": 10,
      "totalPages": 1,
      "currentPage": 1
    }
  },
  "statusCode": 200,
  "timestamp": "2026-07-22T10:25:00.000Z"
}
```

### Next steps

* [Get a single customer](/api-reference/customer/getById) by id.
* [Update a customer's details](/api-reference/customer/update).
* [Fetch a customer's IRMs](/api-reference/irm/post).


## OpenAPI

````yaml GET /platform-customers
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:
  /platform-customers:
    get:
      summary: List platform customers
      description: >-
        Return paginated platform customers for the current platform account.
        Supports page, limit (max 100) and search.
      operationId: listPlatformCustomers
      parameters:
        - name: page
          in: query
          description: Page number (starts at 1)
          schema:
            type: integer
            format: int32
            minimum: 1
            default: 1
        - name: limit
          in: query
          description: Items per page
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 100
            default: 10
        - name: search
          in: query
          description: Filter by partial name or email
          schema:
            type: string
      responses:
        '200':
          description: Paginated list of platform customers
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Customer'
                  meta:
                    type: object
                    properties:
                      totalItems:
                        type: integer
                      itemsPerPage:
                        type: integer
                      totalPages:
                        type: integer
                      currentPage:
                        type: integer
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Customer:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the platform customer
        name:
          type: string
        email:
          type: string
          format: email
        type:
          type: string
          enum:
            - customer
          default: customer
        companyName:
          type: string
        address:
          type: string
        platformId:
          type: string
          description: Platform user ID that owns this customer
        isActive:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header

````