Posts API

REST API endpoints for managing blog posts.

List Posts

GET /api/v1/posts

Query Parameters

Parameter	Type	Default	Description
`limit`	`number`	50	Posts per page (1-100)
`offset`	`number`	0	Posts to skip
`query`	`string`	—	Search by post title
`active`	`boolean`	—	Filter by published status
`tag`	`string`	—	Filter by tag

Response

{
  "data": [
    {
      "id": "0191abc0-1234-7def-8000-000000000001",
      "title": "Welcome to Our Store",
      "slug": "welcome-to-our-store",
      "image": "https://cdn.example.com/welcome.jpg",
      "tag": "news",
      "active": true,
      "publishedAt": "2024-06-01T12:00:00.000Z",
      "createdAt": "2024-05-28T09:00:00.000Z"
    }
  ],
  "meta": {
    "count": 12
  }
}

Get Post

GET /api/v1/posts/:idOrSlug

Returns a single blog post by UUID or slug, with full TipTap JSON content and SEO metadata.

Create Post

POST /api/v1/posts

Content must be valid TipTap JSON with type: "doc". The slug must be unique within the store.

Request Body

Field	Type	Required	Description
`title`	`string`	Yes	Post title
`slug`	`string`	Yes	URL slug (lowercase, numbers, hyphens)
`content`	`object`	Yes	TipTap JSON content (`{ type: "doc", content: [...] }`)
`image`	`string`	No	Featured image URL
`tag`	`string`	No	Post tag/category
`active`	`boolean`	No	Visible on storefront
`publishedAt`	`string`	No	ISO 8601 publication date
`seo`	`object`	No	SEO metadata (see below)
`filters`	`object`	No	Key-value metadata filters

SEO Object

Field	Type	Description
`title`	`string`	Meta title
`description`	`string`	Meta description
`canonical`	`string`	Canonical URL

curl -X POST \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Welcome to Our Store",
    "slug": "welcome-to-our-store",
    "content": {
      "type": "doc",
      "content": [
        {
          "type": "paragraph",
          "content": [
            { "type": "text", "text": "Hello and welcome!" }
          ]
        }
      ]
    },
    "tag": "news",
    "active": true,
    "seo": {
      "title": "Welcome | Our Store",
      "description": "Learn about our store and products."
    }
  }' \
  https://your-store.yns.store/api/v1/posts

Update Post

PATCH /api/v1/posts/:idOrSlug

Partially updates a blog post. Only the provided fields are changed. Accepts the same fields as create (all optional).

Delete Post

DELETE /api/v1/posts/:idOrSlug

Permanently deletes a blog post.

PreviousSearchAPI Reference NextSubscribersAPI Reference