Image Folders

Page through a level of the folder tree

Lists the direct children of parent_folder_id (omit it for the root level). Use each folder's has_subfolders to decide whether to expand it and has_images to tell whether it is empty. Pass include_archived=true to include archived folders. Requires the images feature.

get/api/v1/image_folders

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/image_folders
  • 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)

parent_folder_idstring

Parent folder ID (omit for the root level)

include_archivedboolean

Include archived folders

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 folders

Changes

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