Skip to content
Get API key (opens in a new tab)

Storefront UGC

List posts

Returns approved posts that match the requested filters.

GEThttps://api.widget.cevoid.com/v1/posts

Authorizations

Authorizationbearer tokenheaderrequired

Send Authorization: Bearer <key>, where the key is your publishable key.

Query parameters

marketstringrequired

Market identifier used for localized product data.

  • Length: 1 to 256
  • Example: mar_sweden
profile_idstring

Return posts attributed to this profile.

  • Length: 1 to 256
  • Example: prf_jane
label_idstring[]

Return posts with these labels. Repeat the parameter to provide more than one label.

  • Items: 1 to 50
  • Each item: length: 1 to 256
  • Example: ["lbl_summer","lbl_featured"]
label_matchenum<string>

Match any requested label (default) or require all requested labels. Requires label_id. Unknown labels are ignored for any; all returns no posts if any label is unknown. If no labels resolve, no posts are returned.

  • Allowed values: any all
  • Example: any
product_refstring

A Cevoid product or variant ID, provider-native ID, SKU, or barcode. Resolves within this workspace and market and selects the product family, including variants and existing tags. Unknown, ambiguous, or more than 100 candidate matches return an empty page; use a Cevoid product ID to disambiguate. Families with more than 1,000 product records return 400 with product_too_broad.

  • Length: 1 to 256
  • Example: gid://shopify/Product/123
external_collection_idstring

Return posts containing products in this market-specific external collection.

  • Length: 1 to 256
  • Example: summer-sale
cursorstring

Opaque cursor returned by the previous page. Keep all other query parameters unchanged.

  • Length: 1 to 2048
  • Example: eyJjcmVhdGVkQXQiOiIyMDI2LTA4LTAxVDEwOjAwOjAwLjAwMFoifQ
limitintegerDefault: 20

Number of posts to return, from 1 to 50.

  • Range: 1 <= x <= 50
  • Example: 20

Response

200 Successful response application/json

dataobject[]required
Item properties (13)
idstringrequired

Stable public Post identifier.

  • Length: 1 to 256
  • Example: pst_summerlook
typeenum<string>required

Post media type.

  • Allowed values: IMAGE VIDEO
  • Example: IMAGE
mediaobjectrequired
Properties (7)
urlstring<uri>required

CDN URL for the post media.

  • Example: https://cdn.cevoid.com/posts/pst_summerlook.jpg
thumbnail_urlstring<uri>

Smaller preview image when available.

  • Example: https://cdn.cevoid.com/posts/pst_summerlook-thumbnail.jpg
sprite_urlstring<uri>

Video sprite image for timeline previews when available.

  • Example: https://cdn.cevoid.com/posts/pst_summerlook-sprite.jpg
blurhashstring

BlurHash placeholder for the media asset.

  • Example: LEHV6nWB2yk8pyo0adR*.7kCMdnj
aspect_rationumber

Media width divided by height.

  • Range: 0 < x
  • Example: 0.8
duration_secondsnumber

Video duration in seconds.

  • Range: 0 <= x
  • Example: 12.5
has_audioboolean

Whether video media includes an audio track.

  • Example: true
captionstring

Public post caption. Omitted when hide_caption is true.

  • Example: A summer favorite.
hide_captionbooleanrequired

Whether clients should hide the caption.

  • Example: false
altstring

Accessible media description.

  • Example: Person wearing a beige linen shirt outdoors.
video_captionsstring

WebVTT captions for video media.

  • Example: WEBVTT 00:00.000 --> 00:02.000 A summer favorite.
video_descriptionstring

Accessible description of video content.

  • Example: A person turns to show the front and back of a linen shirt.
source_urlstring<uri>

Original public social post URL when available.

  • Example: https://www.instagram.com/p/example/
authorobject
Properties (2)
namestringrequired

Public display name selected for the storefront.

  • Example: @jane
avatar_urlstring<uri>

Public profile image URL when available.

  • Example: https://cdn.cevoid.com/profiles/prf_jane.jpg
tagged_productsobject[]required

Shoppable products in the selected market. Products without a presentation in that market are omitted.

Item properties (10)
idstringrequired

Stable public Product identifier.

  • Length: 1 to 256
  • Example: prd_linen_shirt
titlestringrequired

Market-specific product title.

  • Example: Linen Shirt
typeenum<string>required
  • Allowed values: PRODUCT VARIANT
  • Example: PRODUCT
parent_product_idstring
  • Length: 1 to 256
  • Example: prd_linen_shirt
availabilityenum<string>
  • Allowed values: IN_STOCK OUT_OF_STOCK
  • Example: IN_STOCK
urlstring<uri>

Market-specific storefront URL.

  • Example: https://shop.example.com/products/linen-shirt
image_urlstring<uri>

Market-specific product image URL.

  • Example: https://cdn.cevoid.com/products/linen-shirt.jpg
priceobject

Product price range or exact variant price in the selected market. Omitted when the market hides prices.

Option 1: object
currencystringrequired
min_amountnumberrequired
  • Range: 0 <= x
max_amountnumberrequired
  • Range: 0 <= x
Option 2: object
currencystringrequired
amountnumberrequired
  • Range: 0 <= x
sale_amountnumber
  • Range: 0 <= x
xnumber

Normalized horizontal hotspot position. Omitted together with y when no valid position is stored.

  • Range: 0 <= x <= 1
  • Example: 0.35
ynumber

Normalized vertical hotspot position.

  • Range: 0 <= x <= 1
  • Example: 0.65
published_atstring<date-time>required

Creation time in Cevoid, used for newest-first ordering. This can differ from the original social publication date.

  • Example: 2026-08-01T10:00:00.000Z
has_morebooleanrequired

Whether another page is available.

  • Example: true
next_cursorstring | nullrequired

Opaque cursor for the next page, or null when this is the final page.

  • Example: eyJwdWJsaXNoZWRBdCI6IjIwMjYtMDgtMDFUMTA6MDA6MDAuMDAwWiJ9
Response headers (7)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

Cache-Controlstring

Browser freshness is 60 seconds. Shared caches are fresh for five minutes and may serve stale content while revalidating for another five minutes. TTL is the only invalidation guarantee; moderation or removal may take up to ten minutes because no active purge is performed.

Varystring

Workspace credential headers included in the shared-cache key.

400 Bad request application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any | null
statusintegerrequired

HTTP status code.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable error description.

  • Example: Resource not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

401 Unauthorized application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any | null
statusintegerrequired

HTTP status code.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable error description.

  • Example: Resource not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

403 Forbidden application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any | null
statusintegerrequired

HTTP status code.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable error description.

  • Example: Resource not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

404 Not found application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any | null
statusintegerrequired

HTTP status code.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable error description.

  • Example: Resource not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

422 Validation error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any | null
statusintegerrequired

HTTP status code.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable error description.

  • Example: Resource not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

429 Too many requests application/json

additional_dataobjectrequired

Machine-readable rate-limit details.

Properties (2)
retry_after_secondsintegerrequired
  • Range: 0 <= x
{key}any | null
statusintegerrequired

HTTP status code.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable error description.

  • Example: Resource not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (6)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

Retry-Afterinteger

Seconds to wait before retrying the request

500 Internal server error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any | null
statusintegerrequired

HTTP status code.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable error description.

  • Example: Resource not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

503 Service unavailable application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any | null
statusintegerrequired

HTTP status code.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable error description.

  • Example: Resource not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available