Photos by Album

Returns the images, tags, names and IDs of every custom album in the store.

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

Hosted on api.yotpo.com

This is a public UGC API endpoint on https://api.yotpo.com, not developers.yotpo.com. It needs no access token: the merchant's store ID (app_key) in the path is enough. It's also documented in the UGC API reference.

For Instagram media, the post object includes post_id and post_link. Use post_id to group media from the same Instagram post. For older media, post_id is null, so group by post_link instead.

👍

How to use this endpoint

  • For example responses, click the relevant status code on the right.
Path Params
string
required

The store ID

Query Params
string
required

The name of your custom album. The album name can be found by using the Custom albums endpoint.

int32
Defaults to 1

The page number of a paginated response. Must be greater than zero. Default: 1

int32

The number of results to return per page. Maximum 56 per page.

boolean

Set to true to return only starred images or false for only unstarred images. Omit to return both. If the album has no starred images, true returns 404 Album not found.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json