API Data Provider - Online Help

Collections

Retrieve and manage collections from Bannerbear.

Columns

Name Type ReadOnly References Description
Uid [KEY] String True

Unique collection identifier

CreatedAt Datetime True

Collection creation timestamp

Url String True

API URL for this collection resource

Status String True

Current status of collection generation

The allowed values are pending, completed, failed.

Modifications String False

Array of modifications applied

WebhookUrl String False

Webhook URL for notifications

WebhookResponseCode Integer True

HTTP response code from webhook call

IsTransparent Boolean False

Whether images have transparent background

Metadata String False

Custom metadata string

ZipUrl String True

URL to download collection as ZIP file

ImageUrls String True

Object mapping template IDs to image URLs

Images String True

Array of generated image objects

TemplateSet String False

TemplateSets.Uid

Template set UID reference

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0