REST API reference

All API endpoints reflect your own structure.

For example, the content for mysite.com/blog/art simply comes from api.pullnote.com/blog/art e.g.

https://api.pullnote.com/blog/art?key=YOUR_PULLNOTE_KEY

Adding / Updating / Deleting content

Use POST to the same URL to add a note, PATCH to update and DELETE to remove.

NB: posting to a path that does not exist will create it.
NB2: "folders" do not need to be created, as they are implied by the paths you add

Listing documents in a folder

pass the list=1 parameter e.g.

https://api.pullnote.com/blog?list=1

This assumes you are building a menu and also returns useful surrounding pages:

• parents - for breadcrumb trails
• parent - immediate parent folder
• siblings - other notes in the same folder
• children - if the current path is also a folder

Return format

API calls return and accept note structure variables.

Finding documents

pass the find={} parameter to search and filter e.g.

https://api.pullnote.com/blog?find={title:"Hello","data.city":"Toronto"}

Examples

GET
https://api.pullnote.com/iphone-12-pro-repairs-london?key=YOUR_PULLNOTE_KEY&format=html

{
  "_id":"686f729fd6eecf4e91b37851",
  "path":"iphone-12-pro-repairs-london",
  "title":"On demand iPhone 12 Pro repairs",
  "description":"Fast, professional iPhone 12 Pro repairs across London.",
  "imgUrl":"https://...",
  "created":1752134303405,
  "modified":1752134303405,
  "author":"Billy",
  "data":{"manufacturerID":"1","deviceID":"145","city":"london"},
  "index": 0,
  "content":"<p>...</p>\n"
}

POST/PATCH
https://api.pullnote.com/iphone-12-pro-repairs-london
{
  key: "YOUR_PULLNOTE_KEY"
  title: "Title changes...",
  content: "Content changes..."
}

DELETE
https://api.pullnote.com/iphone-12-pro-repairs-london