light-mode-image
Learn
API ReferenceCWT PDF templates

Retrieve all PDF templates

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_STARTCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESSCREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_FAIL
GET/v2/credentials/compact/pdf/templates

Retrieves a list of all CWT credentials PDF templates available on the tenant.

Analytic events

  • CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_START
  • CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESS
  • CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000
Default100
cursor?string

Starting point for the list of entries.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v2/credentials/compact/pdf/templates"
{  "nextCursor": "string",  "data": [    {      "id": "string",      "name": "string",      "fileName": "string",      "fonts": [        {          "name": "string",          "fileName": "string"        }      ],      "metadata": {        "title": "string"      },      "fields": [        {          "key": "string",          "value": "string",          "isRequired": true,          "alternativeText": "string",          "fontName": "string"        }      ]    }  ]}

How would you rate this page?

Create a PDF template POST

Creates a CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/docs/issuance/cwt-credential-templates/pdf-templates) for more information on how to design a template and structure the `.zip` file. ### **Analytic events** * CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_START * CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_SUCCESS * CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_FAIL

Retrieve a PDF template GET

Retrieves an existing CWT credentials PDF template using its ID. ### **Analytic events** * CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_START * CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_SUCCESS * CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_FAIL