Sign in
Design Templates

Get a design template

Retrieves the details of an existing design template by its ID.

get/v1/designs/{id}

Path parameters

idstring required

The unique ID of the design template

Example:01g8znjvd9h0qbhxqwc6av0txn

The unique ID of the design template

Headers

Certifier-Versionstring required

API version header. Required for all requests.

Example:2022-10-26

API version header. Required for all requests.

Response

Design template details

idstring required

The unique design template's identifier

namestring required

The name of the design template

type'certificate' | 'badge' required

The type of the design template, whether it is a certificate design template or a badge design template

previewUrlstring uri required

The direct URL to a PNG image preview of the design template

createdAtstring date-time required

The date and time when this design template was created. Formatted as an ISO 8601 date and time string

updatedAtstring date-time required

The date and time when this design template was updated. Formatted as an ISO 8601 date and time string

Example response

{
  "id": "01g8znjvd9h0qbhxqwc6av0txn",
  "name": "My first design template",
  "type": "certificate",
  "previewUrl": "https://cdn.certifier.io/911264ad-df05-4aeb-966f-96034b711c10%2Fcertificate-designs%2Fpreviews%2F01k6dfeejfbwn273x2v2jqj4an-1759241517660.png",
  "createdAt": "2022-01-01T00:00:00.000Z",
  "updatedAt": "2022-01-01T00:00:00.000Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.