---
title: "Photos by album"
method: GET
path: "/v1/widget/{store_id}/albums/by_name"
---

# Photos by album

`GET /v1/widget/{store_id}/albums/by_name`

## Request

- Base URL: `https://api.yotpo.com`
- URL: `https://api.yotpo.com/v1/widget/{store_id}/albums/by_name`
- Auth: none required

Fetches the custom album payload including album images, tags, names, and ID's of all existing custom albums per account `store_id`.

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 use `post_link` for grouping instead.

## Path parameters

- `store_id` string, required

## Query parameters

- `album_name` string, required
- `page` integer
- `per_page` integer
- `favorite` boolean

## Response `200`

200

- object
  - `status` object: Request status.
    - `code` integer: HTTP status code.
    - `message` string: Status message, for example `OK`.
  - `response` object: Response payload.
    - `pagination` object: Paging details.
      - `page` integer: Current page number.
      - `per_page` integer: Number of images per page.
      - `total` integer: Total number of images across all pages.
    - `images` object[]: Images and videos on this page.
      - `source` string: Where the media came from, for example `instagram`.
      - `image_id` string: Yotpo media ID.
      - `low_resolution_image_url` string: Low-resolution image URL. Protocol-relative (starts with `//`), so add `https:` before using it.
      - `original_image_url` string: Full-size (standard resolution) image URL. Protocol-relative (starts with `//`), so add `https:` before using it.
      - `image_url` string: Thumbnail image URL. Protocol-relative (starts with `//`), so add `https:` before using it.
      - `medium_image_url` string: Medium-size image URL. Protocol-relative (starts with `//`), so add `https:` before using it.
      - `external_media_id` string: The media's ID on the source platform, for example the Instagram media ID.
      - `tagged_products` object[]: Products tagged in this media.
        - `id` integer: Yotpo product ID.
        - `name` string: Product name.
        - `domain_key` string: Your product ID (the external product ID your store sends to Yotpo).
        - `product_link` string: Product page URL.
        - `product_url` string: Product page URL.
        - `image_url` string: Product image URL.
        - `score` unknown
        - `reviews_count` unknown
      - `media_type` string: Media type, for example `image` or `carousel`.
      - `permission_request_status` string
      - `post` object: The social post the media came from.
        - `profile_picture` string: Profile image URL of the account that posted, or `null`.
        - `username` string: Username of the account that posted.
        - `location_name` string: Location tagged on the post, or `null`.
        - `created_time` string: When the post was published (ISO 8601).
        - `hashtags` string[]: Hashtags in the post, without the `#`.
        - `content` string: The post's caption.
        - `votes_up` integer: Number of helpful (up) votes on the media.
        - `votes_down` integer: Number of unhelpful (down) votes on the media.
        - `post_id` string, nullable: Instagram media only. The ID of the Instagram post. Shared by all media from the same carousel post. null for older media - use post_link for grouping instead.
        - `post_link` string: Instagram media only. The permalink of the Instagram post the media belongs to. Shared by all media from the same carousel post. Use it for grouping when post_id is null.
      - `review_id` integer, nullable: ID of the review the image was uploaded with, when `source` is `review`.
      - `review` object, nullable: The review the image was uploaded with, when `source` is `review`.
      - `product` object, nullable: The product the image is tagged to.

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `5bcae8239b6e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/yotpo/apis/app-developer-api/changes/v1/widget/:store_id/albums/by_name/get.md)

---

[API](https://skmtc.dev/yotpo/apis/app-developer-api.md) - [All operations](https://skmtc.dev/yotpo/apis/app-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yotpo/apis/app-developer-api/revisions/5bcae8239b6e?raw)