Figshare API

Tools (138)

Extracted live via the executor SDK.

• articles.accountArticleReport

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

• articles.accountArticleReportGenerate

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

• articles.articleDetails

  View an article

• articles.articleFileDetails

  File by id

• articles.articleFiles

  Files list for article

• articles.articlesList

  Returns a list of public articles

• articles.articlesSearch

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

• articles.articleVersionConfidentiality

  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.

• articles.articleVersionDetails

  Article with specified version

• articles.articleVersionEmbargo

  Embargo for article version

• articles.articleVersions

  List public article versions

• articles.articleVersionUpdate

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

• articles.articleVersionUpdateThumb

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

• articles.privateArticleAuthorDelete

  De-associate author from article

• articles.privateArticleAuthorsAdd

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

• articles.privateArticleAuthorsList

  List article authors

• articles.privateArticleAuthorsReplace

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

• articles.privateArticleCategoriesAdd

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

• articles.privateArticleCategoriesList

  List article categories

• articles.privateArticleCategoriesReplace

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

• articles.privateArticleCategoryDelete

  De-associate category from article

• articles.privateArticleConfidentialityDelete

  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.

• articles.privateArticleConfidentialityDetails

  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.

• articles.privateArticleConfidentialityUpdate

  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.

• articles.privateArticleCreate

  Create a new Article by sending article information

• articles.privateArticleDelete

  Delete an article

• articles.privateArticleDetails

  View a private article

• articles.privateArticleEmbargoDelete

  Will lift the embargo for the specified article

• articles.privateArticleEmbargoDetails

  View a private article embargo details

• articles.privateArticleEmbargoUpdate

  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.

• articles.privateArticleFile

  View details of file for specified article

• articles.privateArticleFileDelete

  Complete file upload

• articles.privateArticleFilesList

  List private files

• articles.privateArticlePrivateLink

  List private links

• articles.privateArticlePrivateLinkCreate

  Create new private link for this article

• articles.privateArticlePrivateLinkDelete

  Disable/delete private link for this article

• articles.privateArticlePrivateLinkUpdate

  Update existing private link for this article

• articles.privateArticlePublish
  • 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.
• articles.privateArticleReserveDoi

  Reserve DOI for article

• articles.privateArticleReserveHandle

  Reserve Handle for article

• articles.privateArticleResource

  Edit article resource data.

• articles.privateArticlesList

  Get Own Articles

• articles.privateArticlesSearch

  Returns a list of private articles filtered by the search parameters

• articles.privateArticleUpdate

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

• articles.privateArticleUploadComplete

  Complete file upload

• articles.privateArticleUploadInitiate

  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).

• authors.privateAuthorDetails

  View author details

• authors.privateAuthorsSearch

  Search for authors

• collections.collectionArticles

  Returns a list of public collection articles

• collections.collectionDetails

  View a collection

• collections.collectionsList

  Returns a list of public collections

• collections.collectionsSearch

  Returns a list of public collections

• collections.collectionVersionDetails

  View details for a certain version of a collection

• collections.collectionVersions

  Returns a list of public collection Versions

• collections.privateCollectionArticleDelete

  De-associate article from collection

• collections.privateCollectionArticlesAdd

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

• collections.privateCollectionArticlesList

  List collection articles

• collections.privateCollectionArticlesReplace

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

• collections.privateCollectionAuthorDelete

  Delete collection author

• collections.privateCollectionAuthorsAdd

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

• collections.privateCollectionAuthorsList

  List collection authors

• collections.privateCollectionAuthorsReplace

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

• collections.privateCollectionCategoriesAdd

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

• collections.privateCollectionCategoriesList

  List collection categories

• collections.privateCollectionCategoriesReplace

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

• collections.privateCollectionCategoryDelete

  De-associate category from collection

• collections.privateCollectionCreate

  Create a new Collection by sending collection information

• collections.privateCollectionDelete

  Delete n collection

• collections.privateCollectionDetails

  View a collection

• collections.privateCollectionPrivateLinkCreate

  Create new private link

• collections.privateCollectionPrivateLinkDelete

  Disable/delete private link for this collection

• collections.privateCollectionPrivateLinksList

  List article private links

• collections.privateCollectionPrivateLinkUpdate

  Update existing private link for this collection

• collections.privateCollectionPublish

  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.

• collections.privateCollectionReserveDoi

  Reserve DOI for collection

• collections.privateCollectionReserveHandle

  Reserve Handle for collection

• collections.privateCollectionResource

  Edit collection resource data.

• collections.privateCollectionsList

  List private collections

• collections.privateCollectionsSearch

  Returns a list of private Collections

• collections.privateCollectionUpdate

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

• institutions.accountInstitutionCuration

  Retrieve a certain curation review by its ID

• institutions.accountInstitutionCurationComments

  Retrieve a certain curation review's comments.

• institutions.accountInstitutionCurations

  Retrieve a list of curation reviews for this institution

• institutions.customFieldsList

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

• institutions.customFieldsUpload

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

• institutions.institutionArticles

  Returns a list of articles belonging to the institution

• institutions.institutionHrfeedUpload

  More info in the HR Feed section

• institutions.postAccountInstitutionReviewCurationIdComments

  Add a new comment to the review.

• institutions.privateAccountInstitutionUser

  Retrieve institution user information using the account_id

• institutions.privateCategoriesList

  List institution categories (including parent Categories)

• institutions.privateGroupEmbargoOptionsDetails

  Account institution group embargo options details

• institutions.privateInstitutionAccountGroupRoleDelete

  Delete Institution Account Group Role

• institutions.privateInstitutionAccountGroupRoles

  List Institution Account Group Roles

• institutions.privateInstitutionAccountGroupRolesCreate

  Add Institution Account Group Roles

• institutions.privateInstitutionAccountsCreate

  Create a new Account by sending account information

• institutions.privateInstitutionAccountsList

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

• institutions.privateInstitutionAccountsSearch

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

• institutions.privateInstitutionAccountsUpdate

  Update Institution Account

• institutions.privateInstitutionArticles

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

• institutions.privateInstitutionDetails

  Account institution details

• institutions.privateInstitutionEmbargoOptionsDetails

  Account institution embargo options details

• institutions.privateInstitutionGroupsList

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

• institutions.privateInstitutionRolesList

  Returns the roles available for groups and the institution group.

• other.categoriesList

  Returns a list of public categories

• other.fileDownload

  Starts the download of a file

• other.itemTypesList

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

• other.licensesList

  Returns a list of public licenses

• other.privateAccount

  Account information for token/personal token

• other.privateFundingSearch

  Search for fundings

• other.privateLicensesList

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

• projects.privateProjectArticleDelete

  Delete project article

• projects.privateProjectArticleDetails

  Project article details

• projects.privateProjectArticleFile

  Project article file details

• projects.privateProjectArticleFiles

  List article files

• projects.privateProjectArticlesCreate

  Create a new Article and associate it with this project

• projects.privateProjectArticlesList

  List project articles

• projects.privateProjectCollaboratorDelete

  Remove project collaborator

• projects.privateProjectCollaboratorsInvite

  Invite users to collaborate on project or view the project

• projects.privateProjectCollaboratorsList

  List Project collaborators and invited users

• projects.privateProjectCreate

  Create a new project

• projects.privateProjectDelete

  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.

• projects.privateProjectDetails

  View a private project

• projects.privateProjectLeave

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

• projects.privateProjectNote

  Project note details

• projects.privateProjectNoteDelete

  Delete project note

• projects.privateProjectNotesCreate

  Create a new project note

• projects.privateProjectNotesList

  List project notes

• projects.privateProjectNoteUpdate

  Update project note

• projects.privateProjectPublish

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

• projects.privateProjectsList

  List private projects

• projects.privateProjectsSearch

  Search inside the private projects

• projects.privateProjectUpdate

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

• projects.projectArticles

  List articles in project

• projects.projectDetails

  View a project

• projects.projectsList

  Returns a list of public projects

• projects.projectsSearch

  Returns a list of public articles

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools