The API (short for “Application Programming Interface”) is the primary way to communicate with a running Zettelstore. Most integration with other systems and services is done through the API. The web user interface is just an alternative, secondary way of interacting with a Zettelstore.
The API is HTTP-based and uses JSON as its main encoding format for exchanging messages between a Zettelstore and its client software.
There is an overview zettel that shows the structure of the endpoints used by the API and gives an indication about its use.
While JSON is the main encoding format, it is possible to retrieve zettel representations in other formats. If you want to create a new zettel or to change an existing one, you have to use JSON. There is an overview zettel for encoding formats that describes the valid formats.
Various parts of a zettel can be retrieved. There are the possible values to specify zettel parts.
If authentication is enabled, most API calls must include an access token that proves the identity of the caller.
- Authenticate an user to obtain an access token
- Renew an access token without costly re-authentication
- Provide an access token when doing an API call
- List metadata of all zettel
- List all zettel, but in different encoding formats
- List all zettel, but include different parts of a zettel
- Shape the list of zettel metadata with filter options
- Sort the list of zettel metadata
- List all tags
- List all roles
Working with zettel
- Create a new zettel
- Retrieve metadata and content of an existing zettel
- Retrieve references of an existing zettel
- Retrieve context of an existing zettel
- Retrieve zettel order within an existing zettel
- Update metadata and content of a zettel
- Rename a zettel
- Delete a zettel