Get Client Templates

GET https://staging-onlinebusiness.suregifts.com/v2/orders/templates

Retrieves all available voucher templates for the authenticated business client. This includes both client-specific templates and global templates (where clientId is null). Templates can be used to customize the appearance of vouchers sent to recipients.

Request

Method: GET
URL: /v2/orders/templates

Example URL:

https://{baseUrl}/v2/orders/templates

Responses

200 OK – Successful

Field Descriptions:

• data (array) – List of available templates.
  • id (string) – Unique template identifier.
  • name (string) – Template name.
  • screenshotUrl (string) – URL to template preview image.
• statusCode (string) – Request status code ("00" indicates success).
• message (string | null) – Human-readable description of the status code.

Example Response:

JSON

{
    "data": [
        {
            "id": "10041",
            "name": "Monthly Voucher",
            "screenshotUrl": "https://storagesuregiftsprod.blob.core.windows.net/client-templates/t1_..."
        },
        {
            "id": "10042",
            "name": "Default Template",
            "screenshotUrl": "https://storagesuregiftsprod.blob.core.windows.net/client-templates/default.png"
        }
    ],
    "statusCode": "00",
    "message": "Successful"
}

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

500 Internal Server Error

Internal Server Error

Example cURL Request

Bash

curl -X GET \
  'https://{baseUrl}/v2/orders/templates' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'