Skip to main content

Posts endpoints

GET /api/v1/posts​

List the authenticated user's posts.

Auth​

API key or session auth.

Query parameters​

NameTypeRequiredDescription
pagenumberNoDefaults to 1
limitnumberNoDefaults to 20, max 100
tagstringNoLowercase tag filter

Example​

curl "https://api.opendocs.cc/api/v1/posts?page=1&limit=20&tag=api" \
  -H "Authorization: Bearer od_live_xxxxx"

Response​

{
  "posts": [
    {
      "id": "post_123",
      "slug": "checkout-api-reference",
      "title": "Checkout API reference",
      "summary": "Endpoint summary.",
      "visibility": "workspace",
      "isPublished": true,
      "updatedAt": "2026-04-12T10:00:00.000Z",
      "tags": ["api", "checkout"]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  }
}

GET /api/v1/posts/:postId​

Return metadata for one post.

Response shape​

{
  "post": {
    "id": "post_123",
    "slug": "checkout-api-reference",
    "title": "Checkout API reference",
    "summary": "Endpoint summary.",
    "visibility": "workspace",
    "isPublished": true,
    "publishedAt": "2026-04-12T10:00:00.000Z",
    "updatedAt": "2026-04-12T10:00:00.000Z",
    "url": "/yourteam/checkout-api-reference",
    "versionNumber": 1,
    "tags": ["api", "checkout"]
  }
}

GET /api/v1/posts/:postId/raw​

Return the current raw Markdown.

Response shape​

{
  "markdown": "# Checkout API reference\n\nEndpoint summary.",
  "title": "Checkout API reference",
  "slug": "checkout-api-reference",
  "versionNumber": 1
}

Common error​

{
  "error": "not_found"
}