Skip to content
PaprikaPaprikaPaprika

A version's details: fields, sample values, fonts, warnings

GET
/v1/templates/{template}/versions/{version}
curl --request GET \
  --url https://example.com/v1/templates/example/versions/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
template
required
string
/^tpl_[A-Za-z0-9]{16}$/
version
required
string
/^[1-9][0-9]{0,8}|latest$/

Responses

Section titled “Responses”

200

Section titled “200”

The answer.

Media typeapplication/json
object
template
required
string
version
required
integer
sha256
required
string
size
required
integer
name
required
string
pages
required
integer
fields
required

The template’s fields, by name.

object
key
additional properties

A field of the template: its type, whether a value is required, its settings by type (a number’s min, max, step and decimals; a choice’s options) and the group it is in (PAP-134).

object
type
required
string
Allowed values: text number choice switch image
required
boolean
group
string
fieldGroups
required

The groups the fields are shown in, in order (PAP-134).

Array<object>
object
id
required
string
label
required
string
sampleValues
required

Values that render the template, by field name: text, a number, an option’s value or true or false.

object
key
additional properties
string | number | boolean
images
required
Array<string>
fonts
required
Array<object>
object
id
required
string
sha256
required
string
family
required
string
rights
required
object
warnings
required
Array
libraryFonts
required
Array
createdAt
required
string
createdBy
required
string
publishedWith
required
object
build
required
string
version
required
string
brandKit

The brand kit it was published with, its revision then and the kit items it uses (PAP-131).

object
id
string
revision
integer
items
object

Example 

{
  "fields": {
    "additionalProperty": {
      "type": "text"
    }
  }
}

401

Section titled “401”

No key, or not a valid one.

Media typeapplication/json
object
code
required
string
Allowed values: field-unknown field-missing field-not-text glyph-missing font-missing text-overflow max-below-start min-above-start frame-id-duplicate anchor-target-missing anchor-cycle dependency-failed word-broken image-missing image-unsupported frame-size-invalid image-empty frame-off-page component-unknown component-part-outside spot-unused slug-characters-missing image-low-resolution frame-hidden mask-image-svg mask-image-low-resolution stroke-thin stroke-pattern-too-long image-profile-unreadable image-cmyk-profile paper-colours-unreachable paper-image-unreachable font-no-embed image-no-size image-format blobs-unknown blob-kind profile-missing font-rights request-too-large not-found bad-request internal-error busy render-timeout unauthorized scope-missing tenant-unavailable admin-unauthorized admin-disabled tenant-exists values-invalid value-type value-too-long value-characters value-empty value-range template-filename-taken template-invalid font-not-embeddable font-in-use render-too-slow resources-unknown layout-errors preflight-failed api-unreachable queue-full idempotency-conflict job-finished job-abandoned signing-off link-invalid link-expired batch-queue-full batch-too-large records-invalid records-unreadable batch-finished rate-limited combine-too-large image-invalid schema font-rejected blob-rejected layout-failed package-rejected resource-rejected tracking-ignored font-in-kit kit-exists kit-invalid kit-in-use kit-item-in-use kit-item-missing
message
required
string
requestId
string

Example 

{
  "code": "field-unknown"
}

403

Section titled “403”

The key lacks the scope, or its tenant is suspended or deleted.

Media typeapplication/json
object
code
required
string
Allowed values: field-unknown field-missing field-not-text glyph-missing font-missing text-overflow max-below-start min-above-start frame-id-duplicate anchor-target-missing anchor-cycle dependency-failed word-broken image-missing image-unsupported frame-size-invalid image-empty frame-off-page component-unknown component-part-outside spot-unused slug-characters-missing image-low-resolution frame-hidden mask-image-svg mask-image-low-resolution stroke-thin stroke-pattern-too-long image-profile-unreadable image-cmyk-profile paper-colours-unreachable paper-image-unreachable font-no-embed image-no-size image-format blobs-unknown blob-kind profile-missing font-rights request-too-large not-found bad-request internal-error busy render-timeout unauthorized scope-missing tenant-unavailable admin-unauthorized admin-disabled tenant-exists values-invalid value-type value-too-long value-characters value-empty value-range template-filename-taken template-invalid font-not-embeddable font-in-use render-too-slow resources-unknown layout-errors preflight-failed api-unreachable queue-full idempotency-conflict job-finished job-abandoned signing-off link-invalid link-expired batch-queue-full batch-too-large records-invalid records-unreadable batch-finished rate-limited combine-too-large image-invalid schema font-rejected blob-rejected layout-failed package-rejected resource-rejected tracking-ignored font-in-kit kit-exists kit-invalid kit-in-use kit-item-in-use kit-item-missing
message
required
string
requestId
string

Example 

{
  "code": "field-unknown"
}