API Reference
ReviewsLoyaltyApp partnersHelp CenterAPI keys
  1. V3 · Reviews

Retrieve gallery media

get
https://api-cdn.yotpo.com/v3/storefront/stores//widget_instance_id//sorted_media

Returns the media in a Visual UGC gallery, in the order the merchant set. Send source_album_id for a custom gallery, or external_product_id for a product gallery. No access token is needed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

How to use this endpoint

  • No access token is needed. This is a public endpoint served from Yotpo's CDN (api-cdn.yotpo.com).
  • Send either source_album_id (custom gallery) or external_product_id (product gallery), plus size and offset.
Path Params
string
required

Your Yotpo store ID (app key).

string
required

ID of the gallery widget. It's the data-yotpo-instance-id value in the gallery's install code in the Yotpo admin.

Query Params
string

Album the gallery shows (custom galleries). Required unless you send external_product_id.

string

Product whose media the gallery shows (product galleries). Required unless you send source_album_id.

integer
required
1 to 99

Number of items to return. Maximum 99.

integer
required
≥ 0

Number of items to skip, for paging. Start at 0.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 7 days ago

Did this page help you?