> **Source:** https://knowledge.leegality.com/document-execution/api/list-stamp-series > **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/list — List stamp series Returns details of all stamp paper series in your account. **Authentication:** `X-Auth-Token` header required on every request. ## Request URL ``` GET https://app1.leegality.com/api/v3.1/series/list?firstPartyName={firstPartyName}&secondPartyName={secondPartyName}&purpose={purpose}&legend={legend}&underProcess={underProcess}&blocked={blocked}&reserved={reserved}&unused={unused}&used={used}&expired={expired}&total={total} ``` **Environments:** - Production: `https://app1.leegality.com/api/v3.1/series/list` - Sandbox: `https://sandbox.leegality.com/api/v3.1/series/list` --- ## Parameters | Name | In | Required | Type | Description | Example | |------|----|----------|------|-------------|---------| | `firstPartyName` | query | No | boolean | Include the first party name in each series item. **Default:** `false` — field is omitted from response when not requested. | — | | `secondPartyName` | query | No | boolean | Include the second party name in each series item. **Default:** `false` — field is omitted from response when not requested. | — | | `purpose` | query | No | boolean | Include the purpose/use case configured for each series. **Default:** `false` — field is omitted from response when not requested. | — | | `legend` | query | No | boolean | Include the legend text configured for each series. The legend is the descriptive text printed on the stamp paper. **Default:** `false` — field is omitted from response when not requested. | — | | `underProcess` | query | No | boolean | Include the count of stamps currently under process in each series. **Default:** `false` — field is omitted from response when not requested. | — | | `blocked` | query | No | boolean | Include the count of blocked stamps in each series. **Default:** `false` — field is omitted from response when not requested. | — | | `reserved` | query | No | boolean | Include the count of reserved stamps in each series. **Default:** `false` — field is omitted from response when not requested. | — | | `unused` | query | No | boolean | Include the count of unused (available) stamps in each series. **Default:** `false` — field is omitted from response when not requested. | — | | `used` | query | No | boolean | Include the count of used stamps in each series. **Default:** `false` — field is omitted from response when not requested. | — | | `expired` | query | No | boolean | Include the count of expired stamps in each series. **Default:** `false` — field is omitted from response when not requested. | — | | `total` | query | No | boolean | Include the total stamp count in each series. **Note:** `total` = `unused` + `underProcess` + `blocked` + `used` + `expired` + `reserved`. **Default:** `false` — field is omitted from response when not requested. | — | --- ## Responses ### 200 — Stamp series list retrieved successfully. Response wrapper for the List Stamp Series API. On success (`status: 1`), `data.seriesList` contains the array of 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` | StampSeriesListData | No | Contains the list of stamp series in the account. See **StampSeriesListData** 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.` | #### StampSeriesListData Contains the list of stamp series in the account. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `seriesList` | array\ | No | Array of stamp series objects. Each object represents one stamp paper series configured in the account. See **StampSeriesItem** below. | — | ##### StampSeriesItem Details of a single stamp paper series. The `seriesNumber`, `state`, and `denomination` fields are always present. All other fields are only included when their corresponding query parameter is set to `true`. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `seriesNumber` | string | No | Unique series number identifying this 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. | `07` | | `state` | string | No | Indian state for which the stamp paper is issued. **Examples:** `"Maharashtra"`, `"Delhi"`, `"Tamil Nadu"`, `"All States Revenue Stamp"`. | `Delhi` | | `denomination` | number | No | Stamp paper denomination (face value) in Indian Rupees. **Format:** Decimal number (e.g., `100.0`, `53.0`, `10.0`). | `53` | | `firstPartyName` | string | No | Name of the first party configured for this series. Only present when `firstPartyName=true` is passed. | `ABCD Limited` | | `secondPartyName` | string | No | Name of the second party configured for this series. Only present when `secondPartyName=true` is passed. | `Second party name` | | `purpose` | string | No | Purpose or use case configured for this series. Only present when `purpose=true` is passed. | `General agreement (as per use case)` | | `legend` | string | No | Legend text printed on the stamp paper. This is the descriptive text that appears on the physical stamp paper. Only present when `legend=true` is passed. | `This Stamp Paper forms an integral part of the agreement bea` | | `underProcess` | integer | No | Number of stamps currently under process in this series. Only present when `underProcess=true` is passed. | `0` | | `blocked` | integer | No | Number of blocked stamps in this series. Only present when `blocked=true` is passed. | `3` | | `reserved` | integer | No | Number of reserved stamps in this series. Only present when `reserved=true` is passed. | `0` | | `unused` | integer | No | Number of unused (available) stamps in this series. Only present when `unused=true` is passed. | `258` | | `used` | integer | No | Number of used stamps in this series. Only present when `used=true` is passed. | `142` | | `expired` | integer | No | Number of expired stamps in this series. Only present when `expired=true` is passed. | `0` | | `total` | integer | No | Total number of stamps in this series (across all statuses). **Formula:** `total` = `unused` + `underProcess` + `blocked` + `used` + `expired` + `reserved`. Only present when `total=true` is passed. | `400` | ### Sample Response (200) ```json { "status": 1, "messages": [ { "code": "simpleWorkFlow.success", "message": "Invitations sent successfully." } ], "data": { "seriesList": [ { "seriesNumber": "07", "state": "Delhi", "denomination": 53, "firstPartyName": "ABCD Limited", "secondPartyName": "Second party name", "purpose": "General agreement (as per use case)", "legend": "This Stamp Paper forms an integral part of the agreement bearing unique ID No. (Doc. ID.,) , executed between tees and the Borrower.", "underProcess": 0, "blocked": 3, "reserved": 0, "unused": 258, "used": 142, "expired": 0, "total": 400 } ] } } ```