Help

This site provides public access to digital resources managed in Zotero libraries, along with experimental tools for managing those resources for qualitative data analysis purposes. The available access routes are listed below.

Rule	Methods	Description
/	GET	Home page of the application. Depending on how the application is configured, this will either show a browsable list of projects or redirect to the application help page.
/annotate/<library_id>/<item_key>	GET, POST	Create or edit an existing annotation
/annotations/<library_id>	GET	Show a list of tags associated with annotations in the selected group library.
/annotations/<library_id>/<tag>	GET	Show the annotations associated with a single tag in a Zotero group library. Each annotation is presented as applicable with the highlighted text passage from the PDF, editor comments, and a list of tags applied to the annotation.
/cluster_tags/<library_id>	GET, POST	Present or process a web form allowing the user to cluster tags in a Zotero group library. A list of tags is presented, which includes only tags that meet all the following critera: (1) the tag is applied to an annotation, (2) the tag is not associated only with annotations that already have cluster tags applied to them, and (3) the tag is not itself a cluster tag. Thematically related tags can be selected using checkboxes. The name of a higher-level "cluster" tag can be entered at the top of the form; this tag will be converted to uppercase and prefixed with the `@` symbol or other character defined in the application settings under `LIBRARY.xxxxxxx.group_tag_prefix`.
/delete/<library_id>/<item_key>	GET	Delete a single item.
/help	GET	Print all defined routes for the application and their endpoint docstrings.
/json/<library_id>/<item_key>	GET	View a json representation of a library item.
/login/<library_id>	GET	Provide access credentials (passkey) for a library. Logged-in users will have access to (1) tools that modify the library content, and (2) binary attachment files if public downloads are disabled for that library.
/logout/<library_id>	GET	Remove access credentials (passkey) for a library.
/raw/<library_id>/<item_key>	GET	Download a binary attachment. This may be an item attachment or an inline image attached to a note.
/rename_tags/<library_id>/	GET, POST	Present a form allowing for the bulk renaming of tags in a Zotero group library. Each tag is presented in an editable field; submitting the form will update the names of all modified tags.
/set_key	GET, POST	Set a password for operations on a library. This endpoint should not be accessed directly, but called as needed by a password-protected page along with a redirect target as the URL parameter.
/sync	GET	Synchronize data with the zotero.org server. Retrieves the metadata for any items that have been created or updated since the last sync.
/sync/<library_id>/<item_key>	GET	Synchronize a single item.
/tags/<library_id>	GET	Show a list of tags in the selected group library.
/tags/<library_id>/<tag_name>	GET	View a list of resources in the library associated with `tag_name`.
/view/<library_id>	GET	View an html representation of the library. The list includes top-level collections but NOT top-level items, as the latter may include items that have been trashed or deleted. (Such items are still accessible in other views.)
/view/<library_id>/<item_key>	GET	View an html representation of a library item. For most items this will be a table showing item metadata; for a note the full content will be shown with the metadata listed below; and for a collection a list of items, sub-collections, and parent collection will be presented in directory index format.