> ## 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. # Find coupon lists > Metadata, reminder settings and code availability counts only. Counts include outstanding sendout reservations as locked. Pages start at 1; pageSize defaults to 25 and is limited to 500. couponListName is an optional case-insensitive substring filter. Archived is optional and defaults to false (active lists only). Set archived to true for archived lists only. No real coupon code values are returned by this endpoint. ## OpenAPI ````json GET /couponList/find { "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/find": { "get": { "tags": [ "Coupon" ], "summary": "Find coupon lists", "description": "Metadata, reminder settings and code availability counts only. Counts include outstanding sendout reservations as locked. Pages start at 1; pageSize defaults to 25 and is limited to 500. couponListName is an optional case-insensitive substring filter. Archived is optional and defaults to false (active lists only). Set archived to true for archived lists only. No real coupon code values are returned by this endpoint.", "operationId": "find", "parameters": [ { "name": "couponListName", "in": "query", "description": "Optional case-insensitive substring of the list name; maximum 50 characters.", "schema": { "type": "string" } }, { "name": "archived", "in": "query", "description": "Return archived lists when true; active lists otherwise.", "schema": { "type": "boolean", "default": false } }, { "name": "page", "in": "query", "description": "Page number, starting at 1.", "schema": { "minimum": 1.0, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Maximum number of lists per page (1-500).", "schema": { "maximum": 500.0, "minimum": 1.0, "type": "integer", "format": "int32", "default": 25 } } ], "responses": { "200": { "description": "A page of coupon list metadata and code counts.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CouponList" } } } } }, "400": { "description": "InvalidParameterException / INVALID_PARAMETER: couponListName exceeds 50 characters, page is below 1, pageSize is outside 1-500, or the requested page exceeds the supported offset range.
UnexpectedErrorException / PERMISSION_DENIED: caller lacks coupon list read permissions. View/edit-own permission restricts results to lists owned by the caller.", "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" } } } } } } ````