Get Return Envelope By ID

  1. API Docs
  2. Return Envelopes
  3. Get Return Envelope By ID

Returns a single return envelope by ID. Only envelopes owned by your client are visible; foreign or unknown IDs return 404.

Parameters
Parameter Type Required Default Description
id Int Yes N/A The return envelope ID (path parameter).
Sample Response
{{
  "id": 7,
  "client_id": 1100,
  "company_name": "Demo Company",
  "name": "Windowed Reply Envelope",
  "description": "#9 windowed reply envelope",
  "sku": "RE9-W",
  "envelope_type": "Windowed",
  "postage_applied": true,
  "cost_per_unit": 0.55,
  "sheet_count": 1,
  "weight_oz": 0.4,
  "duplex": false,
  "color": false,
  "active": true,
  "has_template": true,
  "template_preview": {{
    "file_type": "PDF",
    "metadata_url": "https://next-api.checkissuing.com/return-envelopes/7/template/metadata",
    "preview_url_template": "/return-envelopes/7/template/previews/{{pageNumber}}",
    "view_url": "https://next-api.checkissuing.com/return-envelopes/7/template"
  }},
  "has_png_scan": true,
  "png_scan_url": "https://next-api.checkissuing.com/return-envelopes/7/png-scan?v=1a2b3c4d5e6f7a8b",
  "deleted": false,
  "created_at": "2026-09-05 10:00:00",
  "updated_at": "2026-09-05 10:00:00",
  "deleted_at": null
}}

template_preview appears only when a staff-uploaded PDF template exists and is viewable by your credential; png_scan_url appears only when an active PNG proof exists and is versioned so replaced proofs are never served stale.