---
title: "Retrieve User Generated Content"
method: GET
path: "/ugc"
tags: ["User Generated Content"]
---

# Retrieve User Generated Content

`GET /ugc`

## Query parameters

- `store` string, required
- `sku` string
- `tags` string
- `categories` string
- `include_videos` boolean
- `per_page` number

## Response `200`

OK

- UgcResponse — User Generated Content Response
  - `ugc` UgcItem[] — User Generated Content
    - `type` string — Type of review (store_review, product_review, store_third_party_review or questions)
    - `type_label` string — Human readable review type (Company, Product, Third Party or Question)
    - `source` string — Origin of review
    - `rating` integer — Rating out of 5
    - `comments` string — Review Text
    - `author` string — Author of Review
    - `date_created` string — Date that the review was submitted
    - `order_id` string — Order reference
    - `sku` string — Product Identifier
    - `helpful_count` string — Number of times review has been flagged as helpful
    - `is_video` integer — Is the UGC item a video
    - `image_raw` string — Raw image file, as uploaded by reviewer / instagram user
    - `image_sm` string — Image resized to 500px wide.
    - `image_md` string — Image resized to 1080px wide.
    - `image_lg` string — Image resized to 2048px wide
    - `attributes` TimelineReviewAttribute[] — Review Attributes
      - `attribute_id` string — Attribute ID
      - `type` string — Type of attribute (text, star rating, multiple choice)
      - `label` string — Label
      - `options` unknown[] — Possible attribute answers
        - unknown
      - `value` string — Value
    - `tagged_products` UgcTaggedProduct[] — Products that appear in the image
      - `sku` string — Product identifier
      - `top` integer — Y coordinate of product in the image as a percentage
      - `left` integer — X coordinate of product in the image as a percentage
      - `product` object — Details of the tagged product
        - `sku` string — Product identifier
        - `name` string — Product Name
        - `description` string — Product Description
        - `link` string — Product URL
        - `image_url` string — Product Image URL
        - `price` string — Product Price
        - `rating` string — Product Overall Rating
        - `review_count` string — Product Review Count
    - `replies` TimelineReviewReply[] — Public replies added to the review
      - `comments` string — Reply Text
      - `date_created` string — Date that the review was submitted
      - `author` object — Author of reply
        - `name` string — Name of author
        - `avatar` string — Avatar of author

---

[API](https://skmtc.net/reviews/apis/reviews-io-api.md) · [All operations](https://skmtc.net/reviews/apis/reviews-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reviews/reviews-io-api/versions/ea87e0d855cc/schema)