Accessing images via the REST API

Mike Edwards asked on March 31, 2025 07:45

Hi! I'm evaluating Kentico for a client, and we're trying to see how it can handle a specific use case. The client would like to:

Have non-technical users create a form that other non-technical users can access to create and update a few fields for simple objects (not pages, just objects that work like basic DB records)
Have those fields include some basic strings (name, job title), integers (year), and, most crucially, an image.
Allow this data, including a URL for the image attachment, to be accessible via a REST API outside of Kentico.
Is this something Kentico (either Kentico Xperience or Xperience by Kentico) can handle?
Does it require custom development at all, or can forms the non-technical users create have their data be accessed via a REST API at a specific endpoint?
What form do attachments like images take in the JSON output? Is their an example of JSON output that includes what image days would look like in the REST API? The article we read on the REST API didn't seem to show that. Does it provide a publicly accessible URL? Dimensions? File size?

Thanks in advance!

rest images attachment

Recent Answers

Juraj Ondrus answered on April 2, 2025 07:23

For Kentico 13 you can use REST API and request the bizformitem data as described in the documentation.
In Xperience by Kentico REST is not available, but you could use GraphQL - but this is designed to be used with headless channel.

In Kentico 13, the form attachments are stored on disk. So, the actual value in the attachment field is the GUID of the file - so, this GUID value is returned in the JSON. I would recommend using PostMan and do some tests to see how it works and looks like.

0 votesVote for this answer Mark as a Correct answer

Mike Edwards answered on April 3, 2025 01:15

Hmm, okay, I see. So, with the form attachment, once I get the GUID from the bizformitem call, is there another REST call I can make that would resolve the GUID to specific image data (path on the disk, accessible url, dimensions, file size, etc.?) Something like calling /<object type>/global/<object code name or guid> from the docs? We don't have Kentico set up, since we're just starting to investigate it as a possible purchase, so we don't have a store we can query with Postman yet. Any docs on the REST API, specifically as it relates to attachments/images, are very much appreciated

0 votesVote for this answer Mark as a Correct answer

Juraj Ondrus answered on April 3, 2025 05:22

The form files are stored on disk in ~/< site code name>/BizFormFiles folder -, so once you have the GUID, you can compose the link to the file. Keep in mind that these files can be accessed only when authenticated and authorized!
The REST API documentation is linked in my previous message - you can read through the entire section to see how it works and how to work and get the data.

0 votesVote for this answer Mark as a Correct answer

Mike Edwards answered on April 3, 2025 16:43

Ah, ok, I wasn't aware that was the extent of the documentation. Thank you for your time

0 votesVote for this answer Mark as a Correct answer