ParagraphDocs
Open the app
GuidesDevelopers

Get post by ID

GET
/v1/posts/{postId}

Retrieve detailed information about a specific post

Path Parameters

postId*string

Unique identifier of the post

Query Parameters

includeContent?|

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

Response Body

Post details retrieved successfully

application/json
  1. response
id*string

Unique identifier for the post

title*string

Title of the post

Lengthlength <= 200
imageUrl?string

Optional URL to the post's main image

Formaturi
imageAlt?string

Alternative text describing the cover image, shown to screen readers and when the image fails to load

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

Lengthlength <= 300
slug*string

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

Length1 <= length <= 256
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

categories?array<string>

Categories/tags associated with this post

canonicalUrl?string

Canonical URL used in rendered metadata. This does not change the Paragraph permalink.

Formaturi
publishOnline?boolean

Whether the published post is visible on the public website

communityId?string

Subscriber segment id selected for newsletter delivery

authors?array<>

Authors of this post

authorIds?array<string>

IDs of the authors of this post

views?number

Total views. Only included when fetching your own posts via GET /v1/posts

status?string

Current publish status. Only set on authenticated endpoints (listOwn, getById for your own post). Use this instead of publishedAt to determine publish state — publishedAt is preserved across unpublishing.

Value in"published""draft""scheduled""archived"
curl -X GET "https://example.com/v1/posts/string"
{  "id": "string",  "title": "string",  "imageUrl": "http://example.com",  "imageAlt": "string",  "publishedAt": "string",  "updatedAt": "string",  "subtitle": "string",  "slug": "string",  "staticHtml": "string",  "json": "string",  "markdown": "string",  "coinId": "string",  "categories": [    "string"  ],  "canonicalUrl": "http://example.com",  "publishOnline": true,  "communityId": "string",  "authors": [    {      "id": "string",      "walletAddress": "string",      "avatarUrl": "http://example.com",      "publicationId": "string",      "name": "string",      "bio": "string"    }  ],  "authorIds": [    "string"  ],  "views": 0,  "status": "published"}

Get posts in a publication GET

Retrieve a paginated list of published posts from a publication

Delete a post DELETE

Permanently delete a post from your publication. The publication is identified by the API key provided in the Authorization header. **Warning:** This action is irreversible. The post and all related data (notifications and drafts) will be permanently deleted.