List Image Files
Uri: https://api.finerworks.com/v3/list_images
Method: POST
Provides a list of image files you have uploaded and any virtual inventory items assigned to them.
Body
Name | Description | Type | Additional information |
---|---|---|---|
search_filter |
Optional Search query filter |
text |
None. |
session_id |
Optional session id |
text |
None. |
Example JSON Body
application/json, text/json
{ "search_filter": "sample string 1", "session_id": "sample string 2" }
Sample Code Library
curl --location --request sample_method 'https://api.finerworks.comsample_endpoint' \
--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 '{
"search_filter": "sample string 1",
"session_id": "sample string 2"
}'
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api.finerworks.comsample_endpoint');
$request->setMethod(HTTP_Request2::METHOD_sample_method);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'web_api_key' => 'my-web-api-key-goes-here',
'app_key' => 'my-app-key-goes-here'
));
$request->setBody('{
'search_filter': 'sample string 1',
'session_id': 'sample string 2'
}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
var client = new RestClient("https://api.finerworks.comsample_endpoint");
client.Timeout = -1;
var request = new RestRequest(Method.sample_method);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("web_api_key", "my-web-api-key-goes-here");
request.AddHeader("app_key", "my-app-key-goes-here");
request.AddParameter("application/json", "{
'search_filter': 'sample string 1',
'session_id': 'sample string 2'
}, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
var settings = {
"url": "https://api.finerworks.comsample_endpoint",
"method": "sample_method",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"web_api_key": "my-web-api-key-goes-here",
"app_key": "my-app-key-goes-here"
},
"data": JSON.stringify({
'search_filter': 'sample string 1',
'session_id': 'sample string 2'
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'sample_method',
'hostname': 'api.finerworks.com',
'path': 'sample_endpoint',
'headers': {
'Content-Type': 'application/json',
'web_api_key': 'my-web-api-key-goes-here',
'app_key': 'my-app-key-goes-here'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
var postData = JSON.stringify({
"search_filter": "sample string 1",
"session_id": "sample string 2"
});
req.write(postData);
req.end();
require "uri"
require "net/http"
url = URI("https://api.finerworks.comsample_endpoint")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::sample_method.new(url)
request["Content-Type"] = "application/json"
request["web_api_key"] = "my-web-api-key-goes-here"
request["app_key"] = "my-app-key-goes-here"
request.body = "{
'search_filter': 'sample string 1',
'session_id': 'sample string 2'
}"
response = https.request(request)
puts response.read_body
Name | Description | Type | Additional information |
---|---|---|---|
status |
Response status details |
response_status |
None. |
files |
A list of the files uploaded to your account |
array (image_details) |
None. |
Example JSON Response
application/json, text/json
{ "status": { "success": true, "status_code": 200, "message": "", "debug": null }, "files": [ { "guid": "02bd86f3-d307-4fee-8566-fe75385461ba", "title": "My Image", "description": "Some interesting things about this image...", "file_name": "myimage.jpg", "file_thumbnail_uri": "https://finerworks.com/myimages/myimage_thumb.jpg", "file_preview_uri": "https://finerworks.com/myimages/myimage_small.jpg", "personal_gallery_title": null, "members_gallery_category": null, "file_hires_uri": "https://finerworks.com/myimages/myimage.jpg", "file_size": 100000, "pix_w": 2000, "pix_h": 3000, "date_added": "2023-05-30T15:47:39.7528141-05:00", "active": true, "products": [ { "monetary_format": "USD", "quantity": 1, "sku": "AP1556P79511", "product_code": null, "per_item_price": 113.0, "total_price": 113.0, "asking_price": 200.0, "name": null, "description_short": null, "description_long": null, "image_url_1": "https://somewhere.com/image.png", "image_url_2": null, "image_url_3": null, "image_url_4": null, "image_url_5": null, "image_guid": "02bd86f3-d307-4fee-8566-fe75385461ba" } ] } ] }