Documentation Knowledgebase

This area helps us show you how to use our features to grow your business.

OpenContent Helper

Use the Public Gallery API

Use the anonymous, read-only OpenContent Helper gallery API to list published images with search, category, tag, location, sorting, and paging filters, read one image by slug or ID, and load categories and tags for filters.

Updated

Use the gallery API when an OpenContent template needs published gallery data. The base URL is /DesktopModules/OpenContentHelper/API/Gallery.

List images

Call:

GET /Images

Optional filters include search, categorySlug, categoryId, tagSlug, tagId, location, sortBy, pageNumber, and pageSize.

Example:

/DesktopModules/OpenContentHelper/API/Gallery/Images?categorySlug=ribbon-cuttings&pageNumber=1&pageSize=20

Read one image

  • Prefer GET /Image?slug=my-image-slug for a public detail page.
  • Use GET /ImageById?id=123 only when a stable image ID is already available.

Missing or invalid values return a client error. An image that is not published or does not belong to the current portal is not returned.

Load filters

  • GET /Categories lists categories that have published images.
  • GET /Tags lists tags that have published images.

These endpoints are anonymous and read-only. Upload, edit, replace, and delete actions remain in the Image Gallery Management module.

Topics: