API Reference
Content
CRUD operations for site content, scoped to the authenticated user's site.
GET
Retrieves content items for the authenticated user's site with pagination, sorting, and filtering.
page?integerPage number
Range
1 <= valueDefault
1limit?integerItems per page
Range
1 <= value <= 100Default
20sort?stringSort field
Default
"updated_at"Value in
"created_at""updated_at""published_at""title"status?stringFilter by status
Value in
"draft""published"type?stringFilter by content type
Value in
"post""page"Content list
application/json- response
data*array<>meta*curl -X GET 'https://example.com/api/content'Example Response
{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1", "authorId": "string", "title": "string", "slug": "string", "body": {}, "status": "draft", "contentType": "post", "excerpt": "string", "featureImage": "http://example.com", "metaTitle": "string", "metaDescription": "string", "ogImage": "http://example.com", "publishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "meta": { "total": 0, "page": 0, "limit": 0, "pages": 0 }}POST
Creates a new content item for the authenticated user's site. Slug is auto-generated from title if not provided.
application/json- body
title*stringContent title
Length
1 <= lengthbody?|JSON content body
status?stringDefault
"draft"Value in
"draft""published"slug?stringURL slug (auto-generated from title if omitted)
contentType?stringDefault
"post"Value in
"post""page"excerpt?stringLength
length <= 500featureImage?stringFormat
urimetaTitle?stringLength
length <= 300metaDescription?stringLength
length <= 500ogImage?stringFormat
uriContent created
application/json- response
id*stringFormat
uuidsiteId*stringFormat
uuidauthorId*stringtitle*stringslug?stringbody?|JSON content body
status*stringValue in
"draft""published"contentType*stringValue in
"post""page"excerpt?stringfeatureImage?stringFormat
urimetaTitle?stringmetaDescription?stringogImage?stringFormat
uripublishedAt?stringFormat
date-timecreatedAt*stringFormat
date-timeupdatedAt*stringFormat
date-timecurl -X POST 'https://example.com/api/content' \ -H 'Content-Type: application/json' \ -d '{ "title": "string"}'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1", "authorId": "string", "title": "string", "slug": "string", "body": {}, "status": "draft", "contentType": "post", "excerpt": "string", "featureImage": "http://example.com", "metaTitle": "string", "metaDescription": "string", "ogImage": "http://example.com", "publishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}GET
Retrieves a single content item by ID for the authenticated user's site.
id*stringContent ID
Format
uuidContent item
application/json- response
id*stringFormat
uuidsiteId*stringFormat
uuidauthorId*stringtitle*stringslug?stringbody?|JSON content body
status*stringValue in
"draft""published"contentType*stringValue in
"post""page"excerpt?stringfeatureImage?stringFormat
urimetaTitle?stringmetaDescription?stringogImage?stringFormat
uripublishedAt?stringFormat
date-timecreatedAt*stringFormat
date-timeupdatedAt*stringFormat
date-timecurl -X GET 'https://example.com/api/content/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1", "authorId": "string", "title": "string", "slug": "string", "body": {}, "status": "draft", "contentType": "post", "excerpt": "string", "featureImage": "http://example.com", "metaTitle": "string", "metaDescription": "string", "ogImage": "http://example.com", "publishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}PUT
Updates an existing content item for the authenticated user's site.
id*stringContent ID
Format
uuidapplication/json- body
title?stringLength
1 <= lengthbody?|nullstatus?stringValue in
"draft""published"slug?stringexcerpt?stringLength
length <= 500featureImage?stringFormat
urimetaTitle?stringLength
length <= 300metaDescription?stringLength
length <= 500ogImage?stringFormat
uriContent updated
application/json- response
id*stringFormat
uuidsiteId*stringFormat
uuidauthorId*stringtitle*stringslug?stringbody?|JSON content body
status*stringValue in
"draft""published"contentType*stringValue in
"post""page"excerpt?stringfeatureImage?stringFormat
urimetaTitle?stringmetaDescription?stringogImage?stringFormat
uripublishedAt?stringFormat
date-timecreatedAt*stringFormat
date-timeupdatedAt*stringFormat
date-timecurl -X PUT 'https://example.com/api/content/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1", "authorId": "string", "title": "string", "slug": "string", "body": {}, "status": "draft", "contentType": "post", "excerpt": "string", "featureImage": "http://example.com", "metaTitle": "string", "metaDescription": "string", "ogImage": "http://example.com", "publishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}DELETE
Deletes a content item for the authenticated user's site. This action cannot be undone.
id*stringContent ID
Format
uuidContent deleted
curl -X DELETE 'https://example.com/api/content/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
Empty
POST
Publishes a content item, setting status to published and publishedAt timestamp.
id*stringFormat
uuidContent published
application/json- response
id*stringFormat
uuidsiteId*stringFormat
uuidauthorId*stringtitle*stringslug?stringbody?|JSON content body
status*stringValue in
"draft""published"contentType*stringValue in
"post""page"excerpt?stringfeatureImage?stringFormat
urimetaTitle?stringmetaDescription?stringogImage?stringFormat
uripublishedAt?stringFormat
date-timecreatedAt*stringFormat
date-timeupdatedAt*stringFormat
date-timecurl -X POST 'https://example.com/api/content/497f6eca-6276-4993-bfeb-53cbbbba6f08/publish'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1", "authorId": "string", "title": "string", "slug": "string", "body": {}, "status": "draft", "contentType": "post", "excerpt": "string", "featureImage": "http://example.com", "metaTitle": "string", "metaDescription": "string", "ogImage": "http://example.com", "publishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}POST
Unpublishes a content item, setting status back to draft.
id*stringFormat
uuidContent unpublished
application/json- response
id*stringFormat
uuidsiteId*stringFormat
uuidauthorId*stringtitle*stringslug?stringbody?|JSON content body
status*stringValue in
"draft""published"contentType*stringValue in
"post""page"excerpt?stringfeatureImage?stringFormat
urimetaTitle?stringmetaDescription?stringogImage?stringFormat
uripublishedAt?stringFormat
date-timecreatedAt*stringFormat
date-timeupdatedAt*stringFormat
date-timecurl -X POST 'https://example.com/api/content/497f6eca-6276-4993-bfeb-53cbbbba6f08/unpublish'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1", "authorId": "string", "title": "string", "slug": "string", "body": {}, "status": "draft", "contentType": "post", "excerpt": "string", "featureImage": "http://example.com", "metaTitle": "string", "metaDescription": "string", "ogImage": "http://example.com", "publishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}GET
Lists all version snapshots for a content item with pagination.
id*stringFormat
uuidpage?integerRange
1 <= valueDefault
1limit?integerRange
1 <= value <= 100Default
20Version list
application/json- response
versions*array<>pagination*curl -X GET 'https://example.com/api/content/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions'Example Response
{ "versions": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "contentId": "21aa1683-ca25-4edf-bc18-01ad04a4821b", "version": 0, "title": "string", "body": {}, "createdAt": "2019-08-24T14:15:22Z" } ], "pagination": { "total": 0, "page": 0, "limit": 0, "pages": 0 }}POST
Creates a new version snapshot of the current content state.
id*stringFormat
uuidVersion created
application/json- response
id*stringFormat
uuidcontentId*stringFormat
uuidversion*integertitle*stringbody?|nullcreatedAt*stringFormat
date-timecurl -X POST 'https://example.com/api/content/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "contentId": "21aa1683-ca25-4edf-bc18-01ad04a4821b", "version": 0, "title": "string", "body": {}, "createdAt": "2019-08-24T14:15:22Z"}GET
Retrieves a specific version snapshot of a content item.
id*stringFormat
uuidversion*integerRange
1 <= valueVersion details
application/json- response
id*stringFormat
uuidcontentId*stringFormat
uuidversion*integertitle*stringbody?|nullcreatedAt*stringFormat
date-timecurl -X GET 'https://example.com/api/content/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/1'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "contentId": "21aa1683-ca25-4edf-bc18-01ad04a4821b", "version": 0, "title": "string", "body": {}, "createdAt": "2019-08-24T14:15:22Z"}POST
Restores content to a previous version. Creates a snapshot of current state before restoring.
id*stringFormat
uuidversion*integerRange
1 <= valueVersion restored
application/json- response
restored*booleannewVersion*integercurl -X POST 'https://example.com/api/content/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/1/restore'Example Response
{ "restored": true, "newVersion": 0}