Skip to content

List Templates

Request

List available templates for the authenticated merchant. Returns both built-in system templates and merchant-uploaded custom templates.

Security
OAuth2
Query
entityIdinteger, (int64)required

Merchant/tenant identifier for tenant isolation

typestring

Filter by template type

Enum:"RECEIPT""RECEIPT_EMAIL"
statusstring

Filter by template status

Enum:"DRAFT""ACTIVE""ARCHIVED"
pageinteger, >= 1

Page number (1-indexed)

Default:1
Example:page=1
pageSizeinteger, [ 1 .. 200 ]

Number of items per page

Default:50
Example:pageSize=50
curl -i -X GET \
  'https://docs.nelnetpay.com/_mock/apis/receipts-service/templates?entityId=0&type=RECEIPT&status=DRAFT&page=1&pageSize=50' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Templates retrieved successfully

Bodyapplication/json
responseCodestringrequired
Example:"A100"
responseMessagestringrequired
Example:"Approved"
responseDetailsnullrequired
objectobjectrequired

Business payload for this operation (null when no payload)

Response
{ "responseCode": "A100", "responseMessage": "Approved", "responseDetails": null, "object": { "results": [ … ], "pagination": { … } } }