YOyotpo

Photos by album

Changed on

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.

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

Path parameters

store_idstring required

The store ID

Query parameters

album_namestring required

The name of your custom album. The album name can be found by using the <a href="https://apidocs.yotpo.com/reference/get-custom-albums" target="_blank">Custom albums</a> endpoint.

pageinteger

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

per_pageinteger

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

favoriteboolean

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.

Response

200

Example response

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "response": {
    "pagination": {
      "page": 1,
      "per_page": 3
    },
    "images": [
      {
        "source": "instagram",
        "image_id": "5a98197f6efb092db231f695",
        "low_resolution_image_url": "//scontent.cdninstagram.com/vp/da9f5101451fa862caabf874716755f6/5B2B50AF/t51.2885-15/e35/p320x320/28156507_165346500940639_6306343443274661888_n.jpg",
        "original_image_url": "//scontent.cdninstagram.com/vp/88cae9a00ac8b10265bd97b7d5ef1159/5B3ECDF8/t51.2885-15/sh0.08/e35/p640x640/28156507_165346500940639_6306343443274661888_n.jpg",
        "image_url": "//scontent.cdninstagram.com/vp/c26ee077c49ceb4567d77ff073439d4e/5B37EEA0/t51.2885-15/s150x150/e35/c0.43.1080.1080/28156507_165346500940639_6306343443274661888_n.jpg",
        "medium_image_url": "//cdn-yotpo-images-production.yotpo.com/Review/208866404/141437668/medium.jpg?1603967988",
        "external_media_id": "1724914648462926403_3220168402",
        "tagged_products": [
          {
            "id": 23626625,
            "name": "Classy Signature T-Shirt",
            "domain_key": "6",
            "product_link": "https://yotpos-demo-store-2.myshopify.com/products/classy-signature",
            "product_url": "https://yotpos-demo-store-2.myshopify.com/products/classy-signature",
            "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/23827964/18687703/square.jpg?1499177861"
          }
        ],
        "media_type": "image",
        "permission_request_status": "approved",
        "post": {
          "profile_picture": "https://scontent.cdninstagram.com/vp/ad77096025c93ac62127bc4788dd5350/5B35AAB4/t51.2885-19/s150x150/18879688_1351838138239441_1502256565162344448_a.jpg",
          "username": "dey_ag1112",
          "created_time": "2018-02-28T19:24:31.000+00:00",
          "hashtags": [
            "spicyblackbeanburger"
          ],
          "content": "🍴\n#lunchtime #saladfordays #morningstarfarms #spicyblackbeanburger #homemadedressing #oliveoil #lemon #himalayansalt #terradelyssa",
          "post_id": "18023257757718362",
          "post_link": "https://www.instagram.com/p/DebdrjIDrrv/"
        }
      }
    ]
  }
}

Changes