> **Source:** https://knowledge.leegality.com/document-execution/api/list-expiring-stamps > **Site:** Leegality Knowledge Base — https://knowledge.leegality.com > **About:** Leegality is a document execution platform covering eSigning, stamps, NeSL, workflows, and REST API integration. > **Navigation:** Every article on this site has a plain-text version at `.txt` (this format). To get an index of all articles with their `.txt` links, read: https://knowledge.leegality.com/llms.txt > **AI Guide:** For instructions on how to navigate this knowledge base as an AI agent, read: https://knowledge.leegality.com/ai-readable.txt --- # GET /v3.1/series/expiry — List expiring stamp series Returns stamp series that are expiring soon or have already expired. **Authentication:** `X-Auth-Token` header required on every request. ## Request URL ``` GET https://app1.leegality.com/api/v3.1/series/expiry?lookUpPeriod={lookUpPeriod}&includeExpired={includeExpired} ``` **Environments:** - Production: `https://app1.leegality.com/api/v3.1/series/expiry` - Sandbox: `https://sandbox.leegality.com/api/v3.1/series/expiry` --- ## Parameters | Name | In | Required | Type | Description | Example | |------|----|----------|------|-------------|---------| | `lookUpPeriod` | query | No | integer | Number of days to look ahead for expiring stamps. Only stamps with an expiry date within this many days from today are returned. For example, `lookUpPeriod=30` returns stamps expiring in the next 30 days. **Default:** `30` **Note:** Negative values return 0 results without error. Non-numeric values return a `typeMismatch` error. | — | | `includeExpired` | query | No | boolean | Whether to include already-expired stamp series in the results. When `true`, **all** expired stamps are included regardless of the `lookUpPeriod` value. The expired entries appear alongside the future-expiring entries, sorted by expiry date. **Default:** `false` **Accepted truthy values:** `true`, `TRUE`, `1`. | — | --- ## Responses ### 200 — Expiring stamp series retrieved successfully. Response wrapper for the List Expiring Stamp Series API. On success (`status: 1`), `data.seriesList` contains the array of expiring stamp series. The `messages` array is empty on success. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `status` | integer | No | API response status. `1` = success, `0` = failure. Allowed: `0`, `1`. | `1` | | `messages` | array\ | No | Array of response messages. Empty array `[]` on success. See **Message** below. | — | | `data` | StampSeriesExpiryData | No | Contains the list of expiring stamp series. See **StampSeriesExpiryData** below. | — | #### Message Message object containing a machine-readable code and a human-readable description. Used for success confirmations, errors, and warnings. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `code` | string | No | Response message code. | `simpleWorkFlow.success` | | `message` | string | No | Human-readable success or error message. | `Invitations sent successfully.` | #### StampSeriesExpiryData Contains the list of expiring stamp series. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `seriesList` | array\ | No | Array of stamp series expiry entries. Each entry represents a unique combination of series number, purchase date, and expiry date. The same series number can appear multiple times if stamps were purchased in separate batches with different expiry dates. Sorted in ascending order by expiry date (earliest expiry first). See **StampSeriesExpiryItem** below. | — | ##### StampSeriesExpiryItem Details of a single stamp series expiry entry. Each entry represents one batch of stamps with a specific purchase and expiry date. The same series number can appear multiple times with different dates. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `expiryDate` | string | No | Expiry date and time of the stamp batch. **Format:** `DD-MM-YYYY HH:MM:SS` (e.g., `"31-12-2025 23:59:59"`). The time component is always `23:59:59` (end of day). | `31-12-2025 23:59:59` | | `purchaseDate` | string | No | Purchase date and time of the stamp batch. **Format:** `DD-MM-YYYY HH:MM:SS` (e.g., `"15-01-2025 12:30:45"`). Contains the actual timestamp of when the stamps were purchased. | `15-01-2025 12:30:45` | | `quantity` | integer | No | Number of stamps in this batch. | `50` | | `seriesNumber` | string | No | Series number identifying the stamp series. **Format:** Numeric string, typically zero-padded (e.g., `"01"`, `"07"`). This is the same value used in the `stampSeries` field of the Create eSigning request API and in the List Stamp Series API. | `07` | ### Sample Response (200) ```json { "status": 1, "messages": [ { "code": "simpleWorkFlow.success", "message": "Invitations sent successfully." } ], "data": { "seriesList": [ { "expiryDate": "31-12-2025 23:59:59", "purchaseDate": "15-01-2025 12:30:45", "quantity": 50, "seriesNumber": "07" } ] } } ```