Skip to main content
GET
Get post by ID

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Unique identifier

Example:

"507f1f77bcf86cd799439011"

Query Parameters

market
string

Market ID or shortId for localized content

Example:

"us"

Response

Successful response

id
string
required

Unique identifier for the post within the Cevoid system

Example:

"post_abc123def456"

createdAt
string
required

ISO 8601 timestamp indicating when the post was first created or imported into the Cevoid system

Example:

"2024-01-15T10:30:00.000Z"

media
object
required
taggedProducts
object[]
required

Array of products that have been tagged or featured in this post, including their position coordinates and product details

Example:
origin
object
alt
string

Alternative text description for screen readers and accessibility tools, providing a text-based description of the visual content

Example:

"Woman wearing sunglasses standing next to a red convertible car on a sunny beach"

videoCaptions
string

Transcript or captions for video content, providing text representation of spoken words and audio cues

Example:

"Welcome to our summer collection! Check out these amazing sunglasses perfect for beach days."

videoDescription
string

Detailed description of video content including visual elements, actions, and scenes for accessibility

Example:

"Video shows a woman modeling sunglasses while walking along a sandy beach with palm trees in the background"

instagramUrl
string

Original Instagram post URL if this content was imported from Instagram

Example:

"https://www.instagram.com/p/ABC123DEF456/"

type
string

Media type of the post content, typically "IMAGE" for photos or "VIDEO" for video content

Example:

"IMAGE"

fromInstagram
boolean

Indicates whether this post was imported from Instagram through social media integration

Example:

true

addedByCompany
boolean

Indicates whether this post was uploaded directly by the company/brand rather than user-generated content

Example:

false

instagramDate
string

ISO 8601 timestamp of when the post was originally published on Instagram. Only present for Instagram-sourced content.

Example:

"2024-01-10T14:22:00.000Z"

comment
string

Caption or comment text associated with the post, often containing hashtags, mentions, and descriptions

Example:

"Perfect day at the beach! ☀️ #SummerVibes #BeachLife #Sunglasses"

hideCaption
boolean

Setting to control whether the post caption should be hidden when displaying the post in galleries or widgets

Example:

false

uploadedBy
object