Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview

Get a certificate template with its background URL

GET/api/admin/certificates/templates/{id}
Authorization
AuthorizationBearer token · headerrequired
Path parameters
idstringrequired
min length 1
Responses
200

Success

backgroundUrlstring | nullrequired
Show properties
Any of:
string
string
null
null
templateobjectrequired
Show properties
idstringrequired
namestringrequired
pageSizestringrequired
Show properties
Any of:
string
string
string
string
string
string
currentVersionstring | nullrequired
Show properties
Any of:
string
string
null
null
publishedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
specobjectrequired
Show properties
specVersionnumberrequired
pageSizestringrequired
Show properties
Any of:
string
string
string
string
string
string
sizeobjectrequired
Show properties
wnumberrequired
hnumberrequired
backgroundobject | nullrequired
Show properties
Any of:
object
fileIdstringrequired
contentTypestringrequired
Show properties
Any of:
string
string
string
string
widthnumberrequired
heightnumberrequired
byteSizenumberrequired
null
null
elementsobject[]required
Show properties
Array of object
Any of:
object
idstringrequired
typestringrequired
valuestringrequired
fontstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
sizenumberrequired
xnumberrequired
ynumberrequired
alignstringrequired
Show properties
Any of:
string
string
string
string
string
string
colorstringrequired
autoFitbooleanrequired
maxWidthnumberrequired
object
idstringrequired
typestringrequired
sizenumberrequired
xnumberrequired
ynumberrequired
alignstringrequired
Show properties
Any of:
string
string
string
string
string
string
colorstringrequired
backgroundstringrequired
versionsobject[]required
Show properties
Array of object
versionstringrequired
createdAtstring<date-time>required
401

Unauthorized

errorstringrequired
404

Response for status 404

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET '/api/admin/certificates/templates/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "backgroundUrl": "string",
  "template": {
    "id": "string",
    "name": "string",
    "pageSize": "a4_landscape",
    "currentVersion": "string",
    "publishedAt": "2019-08-24T14:15:22Z"
  },
  "spec": {
    "specVersion": 1,
    "pageSize": "a4_landscape",
    "size": {
      "w": 0,
      "h": 0
    },
    "background": {
      "fileId": "string",
      "contentType": "image/png",
      "width": 0,
      "height": 0,
      "byteSize": 0
    },
    "elements": [
      {
        "id": "string",
        "type": "text",
        "value": "string",
        "font": "jetbrains-mono",
        "size": 0,
        "x": 0,
        "y": 0,
        "align": "left",
        "color": "string",
        "autoFit": true,
        "maxWidth": 0
      }
    ]
  },
  "versions": [
    {
      "version": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Was this page helpful?