Figshare API

Account information for token/personal token. Mocked via Mockzilla.

Get Own Articles

Create a new Article by sending article information

Return status on all reports generated for the account from the oauth credentials

Initiate a new Article Report for this Account. There is a limit of 1 report per day.

Returns a list of private articles filtered by the search parameters. Available as a Mockzilla mock endpoint.

Delete an article

View a private article

Updating an article by passing body parameters; request can also be made with the PATCH method.

List article authors

Associate new authors with the article. This will add new authors to the list of already associated authors. Mockzilla mock: no signup, no API key.

Associate new authors with the article. This will remove all already associated authors and add these new ones

De-associate author from article

List article categories

Associate new categories with the article. This will add new categories to the list of already associated categories

Associate new categories with the article. This will remove all already associated categories and add these new ones. Served by the Mockzilla mock runtime.

De-associate category from article

Delete confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows.

View confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows.

Update confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows.

Will lift the embargo for the specified article. Mocked via Mockzilla.

View a private article embargo details

Note: setting an article under whole embargo does not imply that the article will be published when the embargo will expire. You must explicitly call the publish endpoint to enable this functionality.

List private files

Initiate a new file upload within the article. Either use the link property to point to an existing file that resides elsewhere and will not be uploaded to Figshare or use the other 3 parameters (md5, name, size).

Complete file upload. Available as a Mockzilla mock endpoint.

View details of file for specified article

Complete file upload

List private links

Create new private link for this article

Disable/delete private link for this article. Mockzilla mock: no signup, no API key.

Update existing private link for this article

- If the whole article is under embargo, it will not be published immediately, but when the embargo expires or is lifted. - When an article is published, a new public version will be generated. Any further updates to the article will affect the private article data. In order to make these changes publicly visible, an explicit publish operation is needed.

Reserve DOI for article

Reserve Handle for article

Edit article resource data. Served by the Mockzilla mock runtime.

Updating an article version by passing body parameters; request can also be made with the PATCH method.

For a given public article version update the article thumbnail by choosing one of the associated files

Search for authors

View author details

List institution categories (including parent Categories). Mocked via Mockzilla.

List private collections

Create a new Collection by sending collection information

Returns a list of private Collections

Delete n collection

View a collection. Available as a Mockzilla mock endpoint.

Update collection details; request can also be made with the PATCH method.

List collection articles

Associate new articles with the collection. This will add new articles to the list of already associated articles

Associate new articles with the collection. This will remove all already associated articles and add these new ones

De-associate article from collection. Mockzilla mock: no signup, no API key.

List collection authors

Associate new authors with the collection. This will add new authors to the list of already associated authors

Associate new authors with the collection. This will remove all already associated authors and add these new ones

Delete collection author

List collection categories. Served by the Mockzilla mock runtime.

Associate new categories with the collection. This will add new categories to the list of already associated categories

Associate new categories with the collection. This will remove all already associated categories and add these new ones

De-associate category from collection

List article private links

Create new private link. Mocked via Mockzilla.

Disable/delete private link for this collection

Update existing private link for this collection

When a collection is published, a new public version will be generated. Any further updates to the collection will affect the private collection data. In order to make these changes publicly visible, an explicit publish operation is needed.

Reserve DOI for collection

Reserve Handle for collection. Available as a Mockzilla mock endpoint.

Edit collection resource data.

Search for fundings

Account institution details

Returns the accounts for which the account has administrative privileges (assigned and inherited).

Create a new Account by sending account information. Mockzilla mock: no signup, no API key.

Returns the accounts for which the account has administrative privileges (assigned and inherited).

Update Institution Account

Get Articles from own institution. User must be administrator of the institution

Returns the custom fields in the group the user belongs to, or the ones in the group specified, if the user has access.

Uploads a CSV containing values for a specific custom field of type dropdown_large_list. More details in the Custom Fields section. Served by the Mockzilla mock runtime.

Account institution embargo options details

Returns the groups for which the account has administrative privileges (assigned and inherited).

Account institution group embargo options details

Retrieve a certain curation review by its ID

Retrieve a certain curation review's comments. Mocked via Mockzilla.

Add a new comment to the review.

Retrieve a list of curation reviews for this institution

Returns the roles available for groups and the institution group.

List Institution Account Group Roles

Add Institution Account Group Roles. Available as a Mockzilla mock endpoint.

Delete Institution Account Group Role

Retrieve institution user information using the account_id

This is a private endpoint that requires OAuth. It will return a list with figshare public licenses AND licenses defined for account's institution.

List private projects

Create a new project. Mockzilla mock: no signup, no API key.

Search inside the private projects

A project can be deleted only if: - it is not public - it does not have public articles. When an individual project is deleted, all the articles are moved to my data of each owner. When a group project is deleted, all the articles and files are deleted as well. Only project owner, group admin and above can delete a project.

View a private project

Updating an project by passing body parameters; request can also be made with the PATCH method.

List project articles. Served by the Mockzilla mock runtime.

Create a new Article and associate it with this project

Delete project article

Project article details

List article files

Project article file details. Mocked via Mockzilla.

List Project collaborators and invited users

Invite users to collaborate on project or view the project

Remove project collaborator

Please note: project's owner cannot leave the project.

List project notes. Available as a Mockzilla mock endpoint.

Create a new project note

Publish a project. Possible after all items inside it are public

Returns a list of public articles

Returns a list of public articles, filtered by the search parameters

View an article. Mockzilla mock: no signup, no API key.

Files list for article

File by id

List public article versions

Article with specified version

Confidentiality for article version. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows. Served by the Mockzilla mock runtime.

Embargo for article version

Returns a list of public categories

Returns a list of public collections

Returns a list of public collections

View a collection. Mocked via Mockzilla.

Returns a list of public collection articles

Returns a list of public collection Versions

View details for a certain version of a collection

Starts the download of a file

More info in the HR Feed section. Available as a Mockzilla mock endpoint.

Returns a list of articles belonging to the institution

Returns the list of Item Types of the requested group. If no user is authenticated, returns the item types available for Figshare.

Returns a list of public licenses

Returns a list of public projects

Returns a list of public articles. Mockzilla mock: no signup, no API key.

View a project

List articles in project