Skip to content
PaprikaPaprikaPaprika

A brand kit with its items and revision

GET
/v1/brandkits/{kit}
curl --request GET \
  --url https://example.com/v1/brandkits/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
kit
required
string
/^[a-z0-9][a-z0-9-]{0,62}$/

Responses

Section titled “Responses”

200

Section titled “200”

The answer.

Media typeapplication/json
object
id
required
string
name
required
string
description
required
string
revision
required
integer
counts
required
object
swatches
integer
paragraphStyles
integer
characterStyles
integer
images
integer
components
integer
fonts
integer
updatedAt
required
string
updatedBy
required
string
swatches
required
Array<object>
object
id
required
string
name
string
description

Its usage rule.

string
revision
required

The kit revision it last changed in.

integer
paragraphStyles
required
Array<object>
object
id
required
string
name
string
description

Its usage rule.

string
revision
required

The kit revision it last changed in.

integer
characterStyles
required
Array<object>
object
id
required
string
name
string
description

Its usage rule.

string
revision
required

The kit revision it last changed in.

integer
images
required
Array<object>
object
id
required
string
name
string
description

Its usage rule.

string
revision
required

The kit revision it last changed in.

integer
components
Array<object>
object
id
required
string
name
string
description

Its usage rule.

string
revision
required

The kit revision it last changed in.

integer
fonts
required
Array<object>
object
id
required
string
name
string
description

Its usage rule.

string
revision
required

The kit revision it last changed in.

integer

Example generated

{
  "id": "example",
  "name": "example",
  "description": "example",
  "revision": 1,
  "counts": {
    "swatches": 1,
    "paragraphStyles": 1,
    "characterStyles": 1,
    "images": 1,
    "components": 1,
    "fonts": 1
  },
  "updatedAt": "example",
  "updatedBy": "example",
  "swatches": [
    {
      "id": "example",
      "name": "example",
      "description": "example",
      "revision": 1
    }
  ],
  "paragraphStyles": [
    {
      "id": "example",
      "name": "example",
      "description": "example",
      "revision": 1
    }
  ],
  "characterStyles": [
    {
      "id": "example",
      "name": "example",
      "description": "example",
      "revision": 1
    }
  ],
  "images": [
    {
      "id": "example",
      "name": "example",
      "description": "example",
      "revision": 1
    }
  ],
  "components": [
    {
      "id": "example",
      "name": "example",
      "description": "example",
      "revision": 1
    }
  ],
  "fonts": [
    {
      "id": "example",
      "name": "example",
      "description": "example",
      "revision": 1
    }
  ]
}

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"
}

404

Section titled “404”

Not there, or not the tenant’s.

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"
}