> ## 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 free, locked and total coupon code counts > Matches coupon list overview availability: free is the number of codes with no lock ID minus outstanding sendout reservation amounts, with a minimum of zero. Locked includes code locks and outstanding reservations, capped at the total number of stored codes. Total is the number of stored codes and equals free plus locked. Reservations exceeding available codes result in free = 0 and locked = total. ## OpenAPI ````json GET /couponList/getCounts { "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/getCounts": { "get": { "tags": [ "Coupon" ], "summary": "Get free, locked and total coupon code counts", "description": "Matches coupon list overview availability: free is the number of codes with no lock ID minus outstanding sendout reservation amounts, with a minimum of zero. Locked includes code locks and outstanding reservations, capped at the total number of stored codes. Total is the number of stored codes and equals free plus locked. Reservations exceeding available codes result in free = 0 and locked = total.", "operationId": "getCounts", "parameters": [ { "name": "couponListName", "in": "query", "description": "List name in the authenticated customer; case-insensitive.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Free, locked and total coupon code counts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouponCodeSummary" } } } }, "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": { "CouponCodeSummary": { "type": "object", "properties": { "free": { "type": "integer", "format": "int64" }, "locked": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "ServiceExceptionBean": { "type": "object", "properties": { "errorActor": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" } }, "xml": { "name": "ServiceException" } } } } } ````