arrow_back Back to all endpoints
POST https://test-api.finerworks.com/v3/list_images

List Image Files

Provides a list of image files you have uploaded and any virtual inventory items assigned to them.

Body

Name Description Type Additional information
library Contains parameters which help to determine the location of the image. image_library

Required

search_filter Optional - Search query filter that searches based on text in the title or description. text None.
guid_filter Optional - If you have a list of image guids you can filter by a list of image unique identifiers. array (globally unique identifier) None.
personal_gallery_id_filter Optional - Personal gallery ids as assigned by the user in the FinerWorks Inventory Collections. array (number) None.
public_gallery_id_filter Optional - public gallery ids as assigned by the user to be assigned to a GeoGalleries category. array (number) None.
page_number Optional - Page number. number None.
per_page Optional - Default is 10 however you can display up to 50 at a time. number None.
sort_field Optional - Default is by id. Alternatively these fields can also be used: title, file_name, file_size, date_updated, or date_added. text None.
sort_direction Optional - Default is "DESC" for descending order however if you want it to be ascending order, use "ASC". text None.
upload_date_from Optional - Default is null however you can filter by earliest date uploaded. date None.
upload_date_to Optional - Default is null however you can filter by latest date uploaded. date None.
list_products Optional - Default is false. If set to true, AND viewing inventory files, you can also get a list of virtual inventory products associated with its parent image. boolean None.
active Optional - Default is null. If used, it will filter image files you have listed as active (true) or inactive (false) boolean None.

Example JSON Body

application/json, text/json

{
  "library": {
    "name": "inventory",
    "session_id": "1234567890",
    "account_key": "",
    "site_id": 2
  },
  "search_filter": "",
  "guid_filter": null,
  "personal_gallery_id_filter": null,
  "public_gallery_id_filter": null,
  "page_number": 1,
  "per_page": 10,
  "sort_field": "id",
  "sort_direction": "DESC",
  "upload_date_from": null,
  "upload_date_to": null,
  "list_products": true,
  "active": null
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/list_images' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "library": {
    "name": "inventory",
    "session_id": "1234567890",
    "account_key": "",
    "site_id": 2
  },
  "search_filter": "",
  "guid_filter": null,
  "personal_gallery_id_filter": null,
  "public_gallery_id_filter": null,
  "page_number": 1,
  "per_page": 10,
  "sort_field": "id",
  "sort_direction": "DESC",
  "upload_date_from": null,
  "upload_date_to": null,
  "list_products": true,
  "active": null
}'