Skip to main content
GET
/
v1
/
posts
List draft posts
import { ParagraphAPI } from "@paragraph-com/sdk"

const api = new ParagraphAPI({ apiKey: "your-api-key" })
const { items: drafts, pagination } = await api.posts.list({ status: "draft" })
{
  "items": [
    {
      "id": "<string>",
      "title": "<string>",
      "slug": "<string>",
      "imageUrl": "<string>",
      "publishedAt": "<string>",
      "updatedAt": "<string>",
      "subtitle": "<string>",
      "staticHtml": "<string>",
      "json": "<string>",
      "markdown": "<string>",
      "coinId": "<string>",
      "categories": [
        "<string>"
      ],
      "authors": [
        {
          "id": "<string>",
          "publicationId": "<string>",
          "walletAddress": "<string>",
          "avatarUrl": "<string>",
          "name": "<string>",
          "bio": "<string>",
          "farcaster": {
            "username": "<string>",
            "displayName": "<string>",
            "fid": 123
          }
        }
      ],
      "authorIds": [
        "<string>"
      ],
      "views": 123,
      "status": "published"
    }
  ],
  "pagination": {
    "hasMore": true,
    "cursor": "<string>",
    "total": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://paragraph.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key for authenticating protected endpoints. Pass as Bearer token in Authorization header.

Query Parameters

cursor
string

Cursor for pagination

limit
integer
default:10

Maximum number of items to return (1-100, default: 10)

Required range: 1 <= x <= 100
includeContent

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

status
enum<string>

Filter by post status. Default: published

Available options:
published,
draft,
scheduled,
archived

Response

Posts retrieved successfully

items
object[]
required

Array of items in this page

pagination
object
required