Mendeley API
Base URI
Responses
Body
{id}{id}/membersRequest parameters
The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.
Responses
Body
{id}Path variables
Responses
{id}/membersPath variables
Request parameters
The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.
Responses
Body
Responses
Body
{id}{id}{id}/restoreRequest parameters
Group ID. If not supplied, returns user documents
Returns only documents modified since this timestamp. Should be supplied in ISO 8601 format
The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.
The sort order
The field to sort on
View
Responses
Body
{id}Path variables
Document ID
Request parameters
View
Responses
{fileHash}/system{fileHash}/systemPath variables
Filehash of the document
Responses
Body
You should specify a filehash OR at least 1 identifier OR a title for a successful match.Looking up ONLY by authors OR year OR source would not return a result.If matching on ‘title’ then providing authors OR year OR source would improve the lookup.
Request parameters
Responses
{id}{id}{id}Path variables
Request body
Responses
{id}BETA - Stop following a profile, cancel a follow request, or reject a follow request
Path variables
Responses
Request parameters
The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.
Responses
Body
Request body
Responses
{file_id}{file_id}Gets a set of files. At most one of document ID and group ID can be supplied. If neither is supplied, then documents for the logged-in user are returned.
Request parameters
The document ID
The catalog document ID
The group ID
Returns only files added since this timestamp. Should be supplied in ISO 8601 format
Returns files deleted since this timestamp. Should be supplied in ISO 8601 format
Returns files that have been trashed.
The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.
Responses
Request headers
The content disposition, including the filename (see RFC 1806)
The media type of the file
The URL of the document. This should have relation “document” (see RFC 5988)
Request body
Responses
Created, the file has been successfully uploaded and the Location header will contain the file download URL
Body
{id}/actions/send_password_reset_email{id}{id}/actions/send_password_reset_emailPath variables
Request body
Responses
Request body
Responses
Request parameters
Link
Responses
Body
{id}Path variables
Profile ID
Responses
Request body
Responses
Body
Responses
Body
{id}{id}{id}{id}/documents{id}/documents{id}/documents/{document_id}{id}Path variables
Request body
Responses
Body
{id}Path variables
Responses
Body
{id}/documentsPath variables
Request body
Responses
{id}/documentsPath variables
Request parameters
Whether to include trashed document IDs. Defaults to false.
The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.
Responses
Body
Request parameters
Group ID. If not supplied, returns user documents
The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.
Responses
Body
{id}/documents/{document_id}Path variables
Responses
{catalogId}Multiple search fields may be specified. Callers must provide either a query, or at least one of title, author, source or abstract. Setting a minimum or maximum year excludes documents with no defined year.
Request parameters
Query, matches any field
Title
Author
Source, e.g. publication
Abstract
Minimum year
Maximum year
Open access
View
The maximum number of items on the page. If not supplied, the default is 10. The largest allowable value is 100.
Responses
Body
{catalogId}Path variables
Document ID
Request parameters
View
Responses
Request parameters
View
Responses
Body
Responses
Body
{id}Request parameters
First few characters of city name
Max results to return (up to 100)
Responses
Body
{id}Path variables
UUID of the location to retrieve
Responses
Body
{id}{id}{id}{id}/trash{id}Path variables
Document ID
Request parameters
View
Responses
{id}Path variables
Document ID
Request headers
If specified, the document will not be updated if there have been any other changes since this timestamp. Should be specified in RFC 2822 format.
Request body
Responses
Body
Request parameters
Group ID. If not supplied, returns user documents
Returns only documents modified since this timestamp. Should be supplied in ISO 8601 format
Returns only documents deleted since this timestamp. Should be supplied in ISO 8601 format
Returns documents belonging to this profile ID, that do not belong to any group
Returns publications belonging to the profile ID
Returns only documents that are starred
View
The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.
The sort order
The field to sort on
Responses
Body
Request body
Responses
Body
{id}Request parameters
Part of institution name
Max results to return (up to 100)
Responses
Body
{id}Path variables
Institution ID
Responses
Body
Responses
Body
{fileHash}{fileHash}Get the table of contents, tables and figures for the given document
Path variables
Responses
Body
{annotation_id}{annotation_id}{annotation_id}{annotation_id}Path variables
Annotation Id
Request body
Responses
Body
{annotation_id}Path variables
Annotation Id
Responses
Body
Request parameters
Document Id
Group Id
Trashed flag
Returns only annotations modified since this timestamp. Should be supplied in ISO 8601 format
Returns only annotations deleted since this timestamp. Should be supplied in ISO 8601 format
The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 200.
Responses
Body
Request headers
The content disposition, including the filename (see RFC 1806)
The media type of the file
To create a group document from a file, add the URL of the group to add this file to. This should have relation “group” (see RFC 5988)
Request body
Responses
Body
DEPRECATED (use id instead)
DEPRECATED (use id instead)
BETA
BETA
DEPRECATED
BETA
DEPRECATED
BETA
DEPRECATED
BETA
BETA
BETA
DEPRECATED (use institution_details)
BETA
DEPRECATED (use institution_details)
BETA