arrow_back Back to all endpoints

image_details

Provides the details of images within your FinerWorks account used for your virtual inventory and gallery.

Name Description Type Additional information
id Assigned Id number. number None.
guid Unique identifier globally unique identifier None.
title Title you gave the image file text None.
description Description you gave the image file text None.
file_name Original file name (this may have been modified to remove unsafe characters or if the file name was too long) text

Required

file_size File size in bits number

Required

thumbnail_file_name Name of the thumbnail file text

Required

preview_file_name Name of the preview file text

Required

hires_file_name Name of the original hi-res file text

Required

public_thumbnail_uri Location of the thumbnail file text

Required

public_preview_uri Location of a web viewable image file text

Required

personal_gallery_title This field is deprecated - - Query assigned_personal_gallery_ids to get a list of personal galleries this image is associated with. text None.
members_gallery_category This field is deprecated - Query assigned_public_gallery_ids to get a list of public galleries this image is associated with. text None.
private_hires_uri Location of the high resolution file text

Required

pix_w Pixel dimensions - width number

Required

pix_h Pixel dimensions - height number

Required

date_added Date and time the file was uploaded date None.
date_updated Date and time the file was last updated date None.
date_expires Date and time the file will no longer be available and be removed. date None.
active Indicates if the image is viewable by the public in a gallery boolean None.
products Optional - Use either "temporary" or "inventory". Default is "inventory". array (product_details) None.
assigned_gallery_subcategory_ids Gallery categories this image is associated with on GeoGalleries.com array (number) None.
assigned_personal_gallery_ids User created gallery categories this image is associated with on GeoGalleries.com array (number) None.
username Account Username in which the image is assigned. Will only show for Inventory files text None.
account_key Account key in which the image is assigned. text None.
artistname Will be populated only for inventory files text None.
rank Positioning in GeoGalleries set by artist number None.