PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List sites GETCreate a site POSTGet a site GETUpdate a site PATCHDelete a site DELETEPublish a site POSTUnpublish a site POSTList pages GETCreate a page POSTGet a page GETUpdate a page PATCHDelete a page DELETEList collections GETCreate a collection POSTGet a collection GETUpdate a collection PATCHDelete a collection DELETEList collection items GETCreate a collection item POSTGet a collection item GETUpdate a collection item PATCHDelete a collection item DELETEPublish collection items POSTUnpublish collection items POSTArchive collection items POSTUpsert collection items POST
Sites

List collection items

Drafts included. `search` matches name or slug.

GET
/sites/{siteId}/collections/{collectionId}/items

Drafts included. search matches name or slug.

Authorization

x-api-key<token>

In: header

Path Parameters

siteId*string
collectionId*string

Query Parameters

limit?integer
Rangevalue <= 100
Default50
offset?integer
Range0 <= value
Default0
search?string
status?string

Value in

  • "DRAFT"
  • "PUBLISHED"
  • "ARCHIVED"

Response Body

application/json

curl -X GET "https://example.com/sites/string/collections/string/items"
{  "data": [    {      "id": "string",      "collectionId": "string",      "slug": "string",      "status": "DRAFT",      "name": "string",      "data": {        "name": "string"      },      "seo": {        "title": "string",        "description": "string",        "ogImage": "string",        "noindex": true,        "schemaType": "WebPage",        "publishedAt": "string"      },      "publishedSlug": "string",      "publishedAt": "2019-08-24T14:15:22Z",      "hasUnpublishedChanges": true,      "sortOrder": 0,      "contentVersion": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0  }}

Delete a collection DELETE

Deletes its items and template page. Fails while another collection has a reference field pointing at it.

Create a collection item POST

Creates a draft (or ARCHIVED). `publish` true also puts it live. Counts toward the plan's items-per-site limit.