> ## Documentation Index > Fetch the complete documentation index at: https://docs.mapp.com/llms.txt > Use this file to discover all available pages before exploring further. # Get coupon list metadata and counts > Includes previewText, defaultText and reminder settings. A null remindThreshold means reminders are disabled; zero means remind when empty. Preview text defaults to the list name followed by _previewCoupon when unset or empty. Counts include outstanding sendout reservations as locked. No code values are returned. ## OpenAPI ````json GET /couponList/get { "openapi": "3.0.4", "info": { "title": "Engage public API", "version": "1" }, "servers": [ { "url": "https://your-engage-domain.com/api/rest" } ], "tags": [ { "name": "Address Attributes" }, { "name": "Async" }, { "name": "Audit Log" }, { "name": "Automation" }, { "name": "Blacklist" }, { "name": "CMS (legacy)" }, { "name": "CMS Blocks" }, { "name": "CMS Frameworks" }, { "name": "CMS Messages" }, { "name": "CMS Templates" }, { "name": "Contact" }, { "name": "Content" }, { "name": "Coupon" }, { "name": "Draft Message" }, { "name": "Ecommerce" }, { "name": "Group" }, { "name": "Group Attributes" }, { "name": "Landing Page" }, { "name": "Member Attributes" }, { "name": "Membership" }, { "name": "Message" }, { "name": "Meta" }, { "name": "Mobile Push" }, { "name": "Prepared Message" }, { "name": "Process" }, { "name": "Profile Attributes" }, { "name": "Related Data" }, { "name": "Segmentation" }, { "name": "System" }, { "name": "System User" }, { "name": "Usage Statistics" }, { "name": "User" }, { "name": "Whiteboard" } ], "paths": { "/couponList/get": { "get": { "tags": [ "Coupon" ], "summary": "Get coupon list metadata and counts", "description": "Includes previewText, defaultText and reminder settings. A null remindThreshold means reminders are disabled; zero means remind when empty. Preview text defaults to the list name followed by _previewCoupon when unset or empty. Counts include outstanding sendout reservations as locked. No code values are returned.", "operationId": "get", "parameters": [ { "name": "couponListName", "in": "query", "description": "List name in the authenticated customer; case-insensitive.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Coupon list metadata and code counts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouponList" } } } }, "400": { "description": "InvalidParameterException / MISSING_PARAMETER: couponListName is omitted; INVALID_PARAMETER: name length must be 3-50 characters.
NoSuchObjectException / NO_SUCH_OBJECT: no list with this name exists in the authenticated customer.
UnexpectedErrorException / PERMISSION_DENIED: caller lacks read access to this list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceExceptionBean" } } } }, "500": { "description": "UnexpectedErrorException / UNEXPECTED_ERROR: a backend operation failed; errorActor is SERVER.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceExceptionBean" } } } } } } } }, "components": { "schemas": { "CouponList": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "previewText": { "type": "string" }, "defaultText": { "type": "string" }, "archived": { "type": "boolean", "default": false }, "updated": { "type": "integer", "format": "int64" }, "counts": { "$ref": "#/components/schemas/CouponCodeSummary" }, "reminderEnabled": { "type": "boolean", "default": false }, "remindThreshold": { "type": "integer", "format": "int64" }, "additionalReminderEmail": { "type": "string" } } }, "ServiceExceptionBean": { "type": "object", "properties": { "errorActor": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" } }, "xml": { "name": "ServiceException" } }, "CouponCodeSummary": { "type": "object", "properties": { "free": { "type": "integer", "format": "int64" }, "locked": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } } } } } ````