Images

List the business's library images

Lists a business's images (newest first). Filter by folder_id (pass unfiled for images in no folder), source, access, badge, hashtag, archived and published. Requires the images feature.

get/api/v1/images

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/images
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: images:read)

Query parameters

business_idstring

business ID (optional for app tokens; defaults to the token's business)

folder_idstring

Folder ID, or "unfiled" for images with no folder

sourcestring

Filter by source (social_media, aigc, api)

accessstring

Filter by access level (public, private, unlisted)

badgestring

Filter by badge (e.g. ad)

hashtagstring

Filter to images carrying this hashtag

archivedboolean

Filter by archived state

publishedboolean

Filter by published state

afterstring

Opaque cursor for the next page (from pagination.cursor or links.next); ascending order.

beforestring

Opaque cursor for the previous page; descending order.

page_sizeinteger

Page size (default 10, max 100)

Response

Paginated images

Changes

No recorded changes to this operation across all 1 revision of this API.