v13

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-022830130.4 KB
Inbound Email

List Inbound Emails

List all inbound emails associated with your API key. Returns active and paused inbound emails (deleted ones are excluded).

get/v4/inbound-email

Query parameters

status'active' | 'paused' | 'all'

Filter by status

limitinteger

Maximum number of inbound emails to return

offsetinteger

Pagination offset

Response

List of inbound emails

statusstring
totalinteger

Total number of inbound emails (for pagination)

limitinteger
offsetinteger

Example response

{
  "status": "success",
  "inbound_emails": [
    {
      "inbound_email_id": "ie_a1b2c3d4e5f6",
      "email": "ie_a1b2c3d4e5f6@import.casparser.in",
      "reference": "user_12345",
      "callback_url": "https://api.yourapp.com/webhooks/cas-email",
      "allowed_sources": [
        "cdsl",
        "nsdl"
      ],
      "status": "active",
      "metadata": {
        "plan": "premium"
      },
      "created_at": "2025-02-21T10:30:00Z",
      "updated_at": "2025-02-21T10:30:00Z"
    }
  ],
  "total": 15,
  "limit": 50
}