Sign in

v21

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

Get Inbound Email Details

Retrieve details of a specific inbound email including statistics.

get/v4/inbound-email/{inbound_email_id}

Path parameters

inbound_email_idstring required

Inbound Email ID

Response

Inbound email details

allowed_sourcesstring[]

Accepted CAS providers (empty = all)

callback_urlstring uri

Webhook URL for email notifications. If set, we POST each parsed email here. If omitted, files are only retrievable via GET /v4/inbound-email/{id}/files.

created_atstring date-time

When the inbound email was created

emailstring email

The inbound email address to forward CAS statements to

inbound_email_idstring

Unique inbound email identifier

metadataobject

Custom key-value metadata

referencestring nullable

Your internal reference identifier

status'active' | 'paused'

Current inbound email lifecycle status

updated_atstring date-time

When the inbound email was last updated

Example response

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