Figshare API
Figshare apiv2. Using Swagger 2.0
Data & analytics#openapi#open-data
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Figshare apiv2. Using Swagger 2.0
Endpoints 136
other
- GETPrivate Account information
/accountAccount information for token/personal token - POSTSearch Funding
/account/funding/searchSearch for fundings - GETPrivate Account Licenses
/account/licensesThis is a private endpoint that requires OAuth. It will return a list with figshare public licenses AND licenses defined for account's institution. - GETPublic Categories
/categoriesReturns a list of public categories - GETPublic File Download
/file/download/:file_idStarts the download of a file - GETItem Types
/item_types?group_id=0Returns the list of Item Types of the requested group. If no user is authenticated, returns the item types available for Figshare. - GETPublic Licenses
/licensesReturns a list of public licenses
articles
- GETPrivate Articles
/account/articles?page=1&page_size=10&limit=1&offset=0Get Own Articles - POSTCreate new Article
/account/articlesCreate a new Article by sending article information - GETAccount Article Report
/account/articles/export?group_id=0Return status on all reports generated for the account from the oauth credentials - POSTInitiate a new Report
/account/articles/exportInitiate a new Article Report for this Account. There is a limit of 1 report per day. - POSTPrivate Articles search
/account/articles/searchReturns a list of private articles filtered by the search parameters - GETArticle details
/account/articles/:article_idView a private article - PUTUpdate article
/account/articles/:article_idUpdating an article by passing body parameters; request can also be made with the PATCH method. - DELETEDelete article
/account/articles/:article_idDelete an article - GETList article authors
/account/articles/:article_id/authorsList article authors - PUTReplace article authors
/account/articles/:article_id/authorsAssociate new authors with the article. This will remove all already associated authors and add these new ones - POSTAdd article authors
/account/articles/:article_id/authorsAssociate new authors with the article. This will add new authors to the list of already associated authors - DELETEDelete article author
/account/articles/:article_id/authors/:author_idDe-associate author from article - GETList article categories
/account/articles/:article_id/categoriesList article categories - PUTReplace article categories
/account/articles/:article_id/categoriesAssociate new categories with the article. This will remove all already associated categories and add these new ones - POSTAdd article categories
/account/articles/:article_id/categoriesAssociate new categories with the article. This will add new categories to the list of already associated categories - DELETEDelete article category
/account/articles/:article_id/categories/:category_idDe-associate category from article - GETArticle confidentiality details
/account/articles/:article_id/confidentialityView confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items… - PUTUpdate article confidentiality
/account/articles/:article_id/confidentialityUpdate confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items… - DELETEDelete article confidentiality
/account/articles/:article_id/confidentialityDelete confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items… - GETArticle Embargo Details
/account/articles/:article_id/embargoView a private article embargo details - PUTUpdate Article Embargo
/account/articles/:article_id/embargoNote: 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… - DELETEDelete Article Embargo
/account/articles/:article_id/embargoWill lift the embargo for the specified article - GETList article files
/account/articles/:article_id/filesList private files - POSTInitiate Upload
/account/articles/:article_id/filesInitiate 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… - GETSingle File
/account/articles/:article_id/files/:file_idView details of file for specified article - POSTComplete Upload
/account/articles/:article_id/files/:file_idComplete file upload - DELETEFile Delete
/account/articles/:article_id/files/:file_idComplete file upload - GETList private links
/account/articles/:article_id/private_linksList private links - POSTCreate private link
/account/articles/:article_id/private_linksCreate new private link for this article - PUTUpdate private link
/account/articles/:article_id/private_links/:link_idUpdate existing private link for this article - DELETEDisable private link
/account/articles/:article_id/private_links/:link_idDisable/delete private link for this article - POSTPrivate Article Publish
/account/articles/:article_id/publishIf 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… - POSTPrivate Article Reserve DOI
/account/articles/:article_id/reserve_doiReserve DOI for article - POSTPrivate Article Reserve Handle
/account/articles/:article_id/reserve_handleReserve Handle for article - POSTPrivate Article Resource
/account/articles/:article_id/resourceEdit article resource data. - PUTUpdate article version
/account/articles/:article_id/versions/:version_id/Updating an article version by passing body parameters; request can also be made with the PATCH method. - PUTUpdate article version thumbnail
/account/articles/:article_id/versions/:version_id/update_thumbFor a given public article version update the article thumbnail by choosing one of the associated files - GETPublic Articles
/articles?page=1&page_size=10&limit=1&offset=0&order=published_date&order_direction=desc&institution=0&published_since=string&modified_since=string&group=0&resource_doi=string&item_type=0&doi=string&handle=stringReturns a list of public articles - POSTPublic Articles Search
/articles/searchReturns a list of public articles, filtered by the search parameters - GETView article details
/articles/:article_idView an article - GETList article files
/articles/:article_id/filesFiles list for article - GETArticle file details
/articles/:article_id/files/:file_idFile by id - GETList article versions
/articles/:article_id/versionsList public article versions - GETArticle details for version
/articles/:article_id/versions/:v_numberArticle with specified version - GETPublic Article Confidentiality for article version
/articles/:article_id/versions/:v_number/confidentialityConfidentiality for article version. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all… - GETPublic Article Embargo for article version
/articles/:article_id/versions/:v_number/embargoEmbargo for article version
authors
- POSTSearch Authors
/account/authors/searchSearch for authors - GETAuthor details
/account/authors/:author_idView author details
institutions
- GETPrivate Account Categories
/account/categoriesList institution categories (including parent Categories) - GETPrivate Account Institutions
/account/institutionAccount institution details - GETPrivate Account Institution Accounts
/account/institution/accounts?page=1&page_size=10&limit=1&offset=0&is_active=0&institution_user_id=string&email=string&id_lte=0&id_gte=0Returns the accounts for which the account has administrative privileges (assigned and inherited). - POSTCreate new Institution Account
/account/institution/accountsCreate a new Account by sending account information - POSTPrivate Account Institution Accounts Search
/account/institution/accounts/searchReturns the accounts for which the account has administrative privileges (assigned and inherited). - PUTUpdate Institution Account
/account/institution/accounts/:account_idUpdate Institution Account - GETPrivate Institution Articles
/account/institution/articles?page=1&page_size=10&limit=1&offset=0&order=published_date&order_direction=desc&published_since=string&modified_since=string&status=0&resource_doi=string&item_type=0Get Articles from own institution. User must be administrator of the institution - GETPrivate account institution group custom fields
/account/institution/custom_fields?group_id=0Returns the custom fields in the group the user belongs to, or the ones in the group specified, if the user has access. - POSTCustom fields values files upload
/account/institution/custom_fields/:custom_field_id/items/uploadUploads a CSV containing values for a specific custom field of type <b>dropdown_large_list</b>. More details in the <a href="#custom_fields">Custom Fields… - GETPrivate Account Institution embargo options
/account/institution/embargo_optionsAccount institution embargo options details - GETPrivate Account Institution Groups
/account/institution/groupsReturns the groups for which the account has administrative privileges (assigned and inherited). - GETPrivate Account Institution Group Embargo Options
/account/institution/groups/:group_id/embargo_optionsAccount institution group embargo options details - GETInstitution Curation Review
/account/institution/review/:curation_idRetrieve a certain curation review by its ID - GETInstitution Curation Review Comments
/account/institution/review/:curation_id/comments?limit=1&offset=0Retrieve a certain curation review's comments. - POSTPOST Institution Curation Review Comment
/account/institution/review/:curation_id/commentsAdd a new comment to the review. - GETInstitution Curation Reviews
/account/institution/reviews?group_id=0&article_id=0&status=pending&limit=1&offset=0Retrieve a list of curation reviews for this institution - GETPrivate Account Institution Roles
/account/institution/rolesReturns the roles available for groups and the institution group. - GETList Institution Account Group Roles
/account/institution/roles/:account_idList Institution Account Group Roles - POSTAdd Institution Account Group Roles
/account/institution/roles/:account_idAdd Institution Account Group Roles - DELETEDelete Institution Account Group Role
/account/institution/roles/:account_id/:group_id/:role_idDelete Institution Account Group Role - GETPrivate Account Institution User
/account/institution/users/:account_idRetrieve institution user information using the account_id - POSTPrivate Institution HRfeed Upload
/institution/hrfeed/uploadMore info in the <a href="#hr_feed">HR Feed section</a> - GETPublic Licenses
/institutions/:institution_string_id/articles/filter-by?resource_id=string&filename=stringReturns a list of articles belonging to the institution
collections
- GETPrivate Collections List
/account/collections?page=1&page_size=10&limit=1&offset=0&order=published_date&order_direction=descList private collections - POSTCreate collection
/account/collectionsCreate a new Collection by sending collection information - POSTPrivate Collections Search
/account/collections/searchReturns a list of private Collections - GETCollection details
/account/collections/:collection_idView a collection - PUTUpdate collection
/account/collections/:collection_idUpdate collection details; request can also be made with the PATCH method. - DELETEDelete collection
/account/collections/:collection_idDelete n collection - GETList collection articles
/account/collections/:collection_id/articles?page=1&page_size=10&limit=1&offset=0List collection articles - PUTReplace collection articles
/account/collections/:collection_id/articlesAssociate new articles with the collection. This will remove all already associated articles and add these new ones - POSTAdd collection articles
/account/collections/:collection_id/articlesAssociate new articles with the collection. This will add new articles to the list of already associated articles - DELETEDelete collection article
/account/collections/:collection_id/articles/:article_idDe-associate article from collection - GETList collection authors
/account/collections/:collection_id/authorsList collection authors - PUTReplace collection authors
/account/collections/:collection_id/authorsAssociate new authors with the collection. This will remove all already associated authors and add these new ones - POSTAdd collection authors
/account/collections/:collection_id/authorsAssociate new authors with the collection. This will add new authors to the list of already associated authors - DELETEDelete collection author
/account/collections/:collection_id/authors/:author_idDelete collection author - GETList collection categories
/account/collections/:collection_id/categoriesList collection categories - PUTReplace collection categories
/account/collections/:collection_id/categoriesAssociate new categories with the collection. This will remove all already associated categories and add these new ones - POSTAdd collection categories
/account/collections/:collection_id/categoriesAssociate new categories with the collection. This will add new categories to the list of already associated categories - DELETEDelete collection category
/account/collections/:collection_id/categories/:category_idDe-associate category from collection - GETList collection private links
/account/collections/:collection_id/private_linksList article private links - POSTCreate collection private link
/account/collections/:collection_id/private_linksCreate new private link - PUTUpdate collection private link
/account/collections/:collection_id/private_links/:link_idUpdate existing private link for this collection - DELETEDisable private link
/account/collections/:collection_id/private_links/:link_idDisable/delete private link for this collection - POSTPrivate Collection Publish
/account/collections/:collection_id/publishWhen a collection is published, a new public version will be generated. Any further updates to the collection will affect the private collection data. In… - POSTPrivate Collection Reserve DOI
/account/collections/:collection_id/reserve_doiReserve DOI for collection - POSTPrivate Collection Reserve Handle
/account/collections/:collection_id/reserve_handleReserve Handle for collection - POSTPrivate Collection Resource
/account/collections/:collection_id/resourceEdit collection resource data. - GETPublic Collections
/collections?page=1&page_size=10&limit=1&offset=0&order=published_date&order_direction=desc&institution=0&published_since=string&modified_since=string&group=0&resource_doi=string&doi=string&handle=stringReturns a list of public collections - POSTPublic Collections Search
/collections/searchReturns a list of public collections - GETCollection details
/collections/:collection_idView a collection - GETPublic Collection Articles
/collections/:collection_id/articles?page=1&page_size=10&limit=1&offset=0Returns a list of public collection articles - GETCollection Versions list
/collections/:collection_id/versionsReturns a list of public collection Versions - GETCollection Version details
/collections/:collection_id/versions/:version_idView details for a certain version of a collection
projects
- GETPrivate Projects
/account/projects?page=1&page_size=10&limit=1&offset=0&order=published_date&order_direction=desc&storage=group&roles=stringList private projects - POSTCreate project
/account/projectsCreate a new project - POSTPrivate Projects search
/account/projects/searchSearch inside the private projects - GETView project details
/account/projects/:project_idView a private project - PUTUpdate project
/account/projects/:project_idUpdating an project by passing body parameters; request can also be made with the PATCH method. - DELETEDelete project
/account/projects/:project_idA 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… - GETList project articles
/account/projects/:project_id/articles?page=1&page_size=10&limit=1&offset=0List project articles - POSTCreate project article
/account/projects/:project_id/articles?page=1&page_size=10&limit=1&offset=0Create a new Article and associate it with this project - GETProject article details
/account/projects/:project_id/articles/:article_idProject article details - DELETEDelete project article
/account/projects/:project_id/articles/:article_idDelete project article - GETProject article list files
/account/projects/:project_id/articles/:article_id/filesList article files - GETProject article file details
/account/projects/:project_id/articles/:article_id/files/:file_idProject article file details - GETList project collaborators
/account/projects/:project_id/collaboratorsList Project collaborators and invited users - POSTInvite project collaborators
/account/projects/:project_id/collaboratorsInvite users to collaborate on project or view the project - DELETERemove project collaborator
/account/projects/:project_id/collaborators/:user_idRemove project collaborator - POSTPrivate Project Leave
/account/projects/:project_id/leavePlease note: project's owner cannot leave the project. - GETList project notes
/account/projects/:project_id/notes?page=1&page_size=10&limit=1&offset=0List project notes - POSTCreate project note
/account/projects/:project_id/notesCreate a new project note - GETProject note details
/account/projects/:project_id/notes/:note_id - PUTUpdate project note
/account/projects/:project_id/notes/:note_id - DELETEDelete project note
/account/projects/:project_id/notes/:note_id - POSTPrivate Project Publish
/account/projects/:project_id/publishPublish a project. Possible after all items inside it are public - GETPublic Projects
/projects?page=1&page_size=10&limit=1&offset=0&order=published_date&order_direction=desc&institution=0&published_since=string&group=0Returns a list of public projects - POSTPublic Projects Search
/projects/searchReturns a list of public articles - GETPublic Project
/projects/:project_idView a project - GETPublic Project Articles
/projects/:project_id/articlesList articles in project
API details
- Base URL
https://api.figshare.com/v2- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
- Operations
- 136 operations on 96 pathsGET 63POST 40DELETE 17PUT 16
- Main resources
- articles 46collections 32projects 26institutions 23other 7authors 2
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Figshare API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Figshare API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Private Account information” (GET /account), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Figshare API?
Figshare apiv2. Using Swagger 2.0 It is listed under Data & analytics and has 136 endpoints.
Who publishes the Figshare API?
It is listed from Figshare's public API description (an OpenAPI document), not published by Figshare on Swastik Codes. Anyone who controls figshare.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Figshare API?
Requests go to https://api.figshare.com/v2. Endpoint paths are added to this base URL.
How do I authenticate with the Figshare API?
With OAuth 2.0 (authorization code flow) with 1 scope.
How many endpoints does the Figshare API have?
136 operations on 96 paths (63 GET, 40 POST, 17 DELETE, 16 PUT). The largest groups are articles, collections, projects, institutions.
Is forking the Figshare API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.