Skip to main content
GET
List posts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

market
string
required

Market identifier used for localized product data.

Required string length: 1 - 256
Example:

"mar_sweden"

profile_id
string

Return posts attributed to this profile.

Required string length: 1 - 256
Example:

"prf_jane"

label_id
string[]

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

Required array length: 1 - 50 elements

Stable public label identifier.

Required string length: 1 - 256
Example:
label_match
enum<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.

Available options:
any,
all
Example:

"any"

Return posts selected by this published gallery, newest first. Applies gallery filters but not pinned layout order.

Required string length: 1 - 256
Example:

"gal_summer"

product_ref
string

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.

Required string length: 1 - 256
Example:

"gid://shopify/Product/123"

external_collection_id
string

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

Required string length: 1 - 256
Example:

"summer-sale"

cursor
string

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

Required string length: 1 - 2048
Example:

"eyJjcmVhdGVkQXQiOiIyMDI2LTA4LTAxVDEwOjAwOjAwLjAwMFoifQ"

limit
integer
default:20

Number of posts to return, from 1 to 50.

Required range: 1 <= x <= 50
Example:

20

Response

Successful response

data
object[]
required
has_more
boolean
required

Whether another page is available.

Example:

true

next_cursor
string | null
required

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

Example:

"eyJwdWJsaXNoZWRBdCI6IjIwMjYtMDgtMDFUMTA6MDA6MDAuMDAwWiJ9"