API: Retrieve metadata of an existing zettel
The endpoint to work with metadata of a specific zettel is /z/{ID}, where {ID} is a placeholder for the zettel identifier1.
To retrieve the plain metadata of a zettel, use the query parameter part=meta
# curl 'http://127.0.0.1:23123/z/00001012053400?part=meta'
title: API: Retrieve metadata of an existing zettel
role: manual
tags: #api #manual #zettelstore
syntax: zmk
To return a JSON object, use also the query parameter enc=json.
# curl 'http://127.0.0.1:23123/z/00001012053400?part=meta&enc=json'
{"meta":{"back":"00001012000000 00001012053300","backward":"00001012000000 00001012053300 00001012920000","box-number":"1","created":"20210726174524","forward":"00001006020000 00001006050000 00001010040100 00001012050200 00001012920000 00001012921200","modified":"20220917175233","published":"20220917175233","role":"manual","syntax":"zmk","tags":"#api #manual #zettelstore","title":"API: Retrieve metadata of an existing zettel"},"rights":62}
Pretty-printed, this results in:
{
"meta": {
"back": "00001012000000 00001012053300",
"backward": "00001012000000 00001012053300 00001012920000",
"box-number": "1",
"created": "20210726174524",
"forward": "00001006020000 00001006050000 00001010040100 00001012050200 00001012920000 00001012921200",
"modified": "20220917175233",
"published": "20220917175233",
"role": "manual",
"syntax": "zmk",
"tags": "#api #manual #zettelstore",
"title": "API: Retrieve metadata of an existing zettel"
},
"rights": 62
}
The following keys of the JSON object are used:
- "meta"
References an embedded JSON object with only string values. The name/value pairs of this objects are interpreted as the metadata of the new zettel. Please consider the list of supported metadata keys (and their value types).
- "rights"
An integer number that describes the access rights for the zettel.
HTTP Status codes
- 200
Retrieval was successful, the body contains an appropriate JSON object.
- 400
Request was not valid. There are several reasons for this. Maybe the zettel identifier did not consist of exactly 14 digits.
- 403
You are not allowed to retrieve data of the given zettel.
- 404
Zettel not found. You probably used a zettel identifier that is not used in the Zettelstore.
- If authentication is enabled, you must include the a valid access token in the Authorization header ↩︎