BAbannerbear

Get a publication

Changed on

Public library publications are visible to any authenticated caller, including legacy V3 ones, whose uid carries a v3_ prefix — a bare V3 uid resolves too. Published publications are only returned to the user who created them.

get/publications/{uid}

Request

  • Base URL
    https://api.bannerbear.com/v5
  • Auth
    HTTP bearer

Path parameters

uidstring required

Response

Publication details

uidstring

A v3_ prefix marks a legacy V3 publication. Pass the uid back verbatim, prefix included.

namestring
descriptionstring nullable
tagsstring[]
categoriesstring[]

Library categories this publication falls into, derived from its tags. These are the values the index endpoint's category filter takes.

visibility'unpublished' | 'published' | 'public_library'

unpublished, published, or public_library

previewstring uri nullable

Preview image or gif URL

install_countinteger

Number of times this publication has been installed into a workspace

template_kind'image' | 'animation'

Which kind of template this publication creates when installed

widthinteger nullable

Canvas width in pixels. Null for a workflow, which has no canvas of its own.

heightinteger nullable

Canvas height in pixels. Null for a workflow, which has no canvas of its own.

published_atstring date-time nullable
created_atstring date-time

Changes

  • 24e6335e0a47Revision changes
    • info

      removed the workflow enum value from the response property for the response status

  • c439420dbe16Revision changes
    • warning

      added the new animation enum value to the response property for the response status

    • warning

      added the new workflow enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status