Changes in Zotero Web API v3
Version 3 of the Zotero Web API introduces a new all-JSON response format and various other changes. While API v3 is mostly backwards compatible, existing clients may need to make a few small adjustments for full compatibility, depending on usage.
- New default all-JSON response format,
- Contains a single JSON object for single-object requests and an array of objects for multi-object requests
- All individual objects contain top-level
versionproperties and top-level
metacontains non-editable system-generated properties like
lastModifiedByUser(for group items),
- Other Atom-specific feed properties (
updated) have been removed.
- Clients sending
Acceptheader will continue to receive Atom responses if no other format is requested
include=datahas replaced Atom's
content=jsonand is now the default mode, with a top-level
dataobject containing the editable fields. As with
content, additional comma-separated types can be requested (e.g.,
include=data,bib). The requested types are provided as top-level properties.
content=htmlremains the default in Atom.
- Multi-object writes now take an array of JSON objects directly, rather than an object with an
searchesproperty containing an array.
- For write requests, the API now accepts either the editable JSON (
data) or the full parent JSON object, with the server extracting the
dataobject automatically. The latter allows for some editing tasks to be performed without any programming.
parsedDateproperty in the
metaobject gives the full parsed date in YYYY-MM-DD form, so that clients don't need to replicate Zotero's date-parsing logic to get exact dates. In v3 Atom,
zapi:numTagsis removed in v3 Atom, since it's unnecessary with the
tagsarray in the editable json.
- The API now returns 25 results per request instead of 50 if
- The total result count for multi-object responses is available in a new custom HTTP header,
zapi:totalResultsis removed in v3 Atom.
alternatelinks for multi-object responses are now provided in the
- The API key can be provided in the
Authorizationrequest header instead of the
keyquery parameter. Since API keys have never been included in the URLs provided in responses, previously all provided URLs had to be modified for key-based access.
- The API version can be provided as a query parameter (
v=3) instead of the
Zotero-API-Versionheader for easier debugging and sharing of requests, though both will remain supported.
- For formats other than Atom,
dateModifieddescending is the default sort instead of
itemVersion(and similar properties on collections and searches) in the editable JSON are now just
versionfor easier handling by clients. Clients that simply pass back the edited JSON without touching those properties shouldn't be affected. Clients that store the JSON will need to modify it before sending in v3.
versionmetadata field in the
computerProgramitem type is now
versionNumberto avoid a conflict with the renamed object version property.
- dateAdded/dateModified are included in the 'data' object in ISO 8601 form. Previously these timestamps were provided only in the Atom
updatedelements, though in v2 they can be sent back in the JSON as
dateModifiedin YYYY-MM-DD hh-mm-dd format, interpreted as UTC. In v3 write requests, either is accepted, though the previous form is deprecated.
accessDatefield, which was also previously YYYY-MM-DD[ hh-mm-dd], is ISO 8601 in v3 (including in Atom) for both reading and writing. The previous form is accepted but deprecated.
- The pagination links (
last) on multi-object responses can be used without modification by clients using the
rel=selflinks in individual objects are meant as base URIs and do not include any query parameters (e.g.,
include=data,bib). This is a change from the previous behavior, where the Atom entry
rel=“self”links include all non-default provided parameters. But with the
include=dataas the new default, the base URI may be sufficient for most individual-object requests.
newerparameter is now
orderparameter is now
- Requests for updated group metadata can now use
pprint=1has been removed, and all responses are now pretty-printed.
- '<', '>', and '&' are no longer unnecessarily escaped to \u…. in returned JSON data. In Atom, these characters are instead turned into XML numeric character references. Proper XML and JSON parsers shouldn't be affected by these changes.
- The HTTP Warning header may be used to send clients non-fatal warnings — such as deprecation warnings — that can be logged.
tl;dr for existing Atom consumers
format=atomexplicitly, or send
Total-ResultsHTTP header instead of
- Count the
tagsarray in editable JSON instead of using
search*) in editable JSON
versionmetadata field in
- Use ISO 8601 dates for
sinceparameter instead of
sortparameter instead of
- For writes, upload an array of JSON objects directly instead of an object containing an
- Optionally, use
Authorization: Bearer <apiKey>instead of
- Optionally, use
vparameter instead of