Skip to main content
GET
/
v1
/
posts
/
{postId}
Get post by ID
import { ParagraphAPI } from "@paragraph_xyz/sdk"

const api = new ParagraphAPI()
const post = await api.getPost({ id: "3T2PQZlsdQtigUp4fhlb" })
{
  "id": "<string>",
  "title": "<string>",
  "imageUrl": "<string>",
  "publishedAt": "<string>",
  "updatedAt": "<string>",
  "subtitle": "<string>",
  "slug": "<string>",
  "staticHtml": "<string>",
  "json": "<string>",
  "markdown": "<string>",
  "coinId": "<string>"
}

Path Parameters

​
postId
string
required

Unique identifier of the post

Query Parameters

​
includeContent
boolean | null

Include full content fields (markdown, json, staticHtml). Default: false

Response

Post details retrieved successfully

​
id
string
required

Unique identifier for the post

​
title
string
required

Title of the post

Maximum length: 200
​
slug
string
required

URL-friendly identifier for the post; accessible at paragraph.com/@[publicationSlug]/[slug]

Required string length: 1 - 256
​
imageUrl
string<uri>

Optional URL to the post's main image

​
publishedAt
string

Epoch timestamp when the post was published

​
updatedAt
string

Epoch timestamp when the post was last updated

​
subtitle
string

Optional subtitle or brief summary

Maximum length: 300
​
staticHtml
string

Rendered HTML content of the post

​
json
string

TipTap JSON representation of the post content structure. This is the source of truth that the staticHtml and markdown is generated from

​
markdown
string

Markdown source of the post content

​
coinId
string

ID of the associated coin, if the post is coined

⌘I