This is the API
Return status on all reports generated for the account from the oauth credentials
https://api.figshare.com/v2/account/articles/export
GET
A group ID to filter by
Initiate a new Article Report for this Account. There is a limit of 1 report per day.
https://api.figshare.com/v2/account/articles/export
POST
View an article
https://api.figshare.com/v2/articles/{article_id}
GET
Article Unique identifier
File by id
https://api.figshare.com/v2/articles/{article_id}/files/{file_id}
GET
Article Unique identifier
File Unique identifier
Files list for article
https://api.figshare.com/v2/articles/{article_id}/files
GET
Article Unique identifier
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.
https://api.figshare.com/v2/articles/{article_id}/versions/{v_number}/confidentiality
GET
Article Unique identifier
Version Number
Article with specified version
https://api.figshare.com/v2/articles/{article_id}/versions/{v_number}
GET
Article Unique identifier
Article Version Number
Embargo for article version
https://api.figshare.com/v2/articles/{article_id}/versions/{v_number}/embargo
GET
Article Unique identifier
Version Number
Updating an article version by passing body parameters; request can also be made with the PATCH method.
https://api.figshare.com/v2/account/articles/{article_id}/versions/{version_id}/
PUT
Article unique identifier
Article version identifier
Article description
For a given public article version update the article thumbnail by choosing one of the associated files
https://api.figshare.com/v2/account/articles/{article_id}/versions/{version_id}/update_thumb
PUT
Article unique identifier
Article version identifier
File ID
List public article versions
https://api.figshare.com/v2/articles/{article_id}/versions
GET
Article Unique identifier
Returns a list of public articles
https://api.figshare.com/v2/articles
GET
Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
Page number. Used for pagination with page_size
The number of results included on a page. Used for pagination with page
Number of results included on a page. Used for pagination with query
Where to start the listing(the offset of the first result). Used for pagination with limit
The field by which to order. Default varies by endpoint/resource.
only return articles from this institution
Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
Filter by article modified date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
only return articles from this group
only return articles with this resource_doi
Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
only return articles with this doi
only return articles with this handle
Returns a list of public articles, filtered by the search parameters
https://api.figshare.com/v2/articles/search
POST
Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
Search Parameters
De-associate author from article
https://api.figshare.com/v2/account/articles/{article_id}/authors/{author_id}
DELETE
Article unique identifier
Article Author unique identifier
Associate new authors with the article. This will add new authors to the list of already associated authors
https://api.figshare.com/v2/account/articles/{article_id}/authors
POST
Article unique identifier
Authors description
List article authors
https://api.figshare.com/v2/account/articles/{article_id}/authors
GET
Article unique identifier
Associate new authors with the article. This will remove all already associated authors and add these new ones
https://api.figshare.com/v2/account/articles/{article_id}/authors
PUT
Article unique identifier
Authors description
Associate new categories with the article. This will add new categories to the list of already associated categories
https://api.figshare.com/v2/account/articles/{article_id}/categories
POST
Article unique identifier
List article categories
https://api.figshare.com/v2/account/articles/{article_id}/categories
GET
Article unique identifier
Associate new categories with the article. This will remove all already associated categories and add these new ones
https://api.figshare.com/v2/account/articles/{article_id}/categories
PUT
Article unique identifier
De-associate category from article
https://api.figshare.com/v2/account/articles/{article_id}/categories/{category_id}
DELETE
Article unique identifier
Category unique identifier
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.
https://api.figshare.com/v2/account/articles/{article_id}/confidentiality
DELETE
Article unique identifier
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.
https://api.figshare.com/v2/account/articles/{article_id}/confidentiality
GET
Article unique identifier
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.
https://api.figshare.com/v2/account/articles/{article_id}/confidentiality
PUT
Article unique identifier
Create a new Article by sending article information
https://api.figshare.com/v2/account/articles
POST
Article description
Delete an article
https://api.figshare.com/v2/account/articles/{article_id}
DELETE
Article unique identifier
View a private article
https://api.figshare.com/v2/account/articles/{article_id}
GET
Article unique identifier
Will lift the embargo for the specified article
https://api.figshare.com/v2/account/articles/{article_id}/embargo
DELETE
Article unique identifier
View a private article embargo details
https://api.figshare.com/v2/account/articles/{article_id}/embargo
GET
Article unique identifier
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.
https://api.figshare.com/v2/account/articles/{article_id}/embargo
PUT
Article unique identifier
Embargo description
View details of file for specified article
https://api.figshare.com/v2/account/articles/{article_id}/files/{file_id}
GET
Article unique identifier
File unique identifier
Complete file upload
https://api.figshare.com/v2/account/articles/{article_id}/files/{file_id}
DELETE
Article unique identifier
File unique identifier
List private files
https://api.figshare.com/v2/account/articles/{article_id}/files
GET
Article unique identifier
List private links
https://api.figshare.com/v2/account/articles/{article_id}/private_links
GET
Article unique identifier
Create new private link for this article
https://api.figshare.com/v2/account/articles/{article_id}/private_links
POST
Article unique identifier
Disable/delete private link for this article
https://api.figshare.com/v2/account/articles/{article_id}/private_links/{link_id}
DELETE
Article unique identifier
Private link token
Update existing private link for this article
https://api.figshare.com/v2/account/articles/{article_id}/private_links/{link_id}
PUT
Article unique identifier
Private link token
- 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.
https://api.figshare.com/v2/account/articles/{article_id}/publish
POST
Article unique identifier
Reserve DOI for article
https://api.figshare.com/v2/account/articles/{article_id}/reserve_doi
POST
Article unique identifier
Reserve Handle for article
https://api.figshare.com/v2/account/articles/{article_id}/reserve_handle
POST
Article unique identifier
Edit article resource data.
https://api.figshare.com/v2/account/articles/{article_id}/resource
POST
Article unique identifier
Resource data
Updating an article by passing body parameters; request can also be made with the PATCH method.
https://api.figshare.com/v2/account/articles/{article_id}
PUT
Article unique identifier
Article description
Complete file upload
https://api.figshare.com/v2/account/articles/{article_id}/files/{file_id}
POST
Article unique identifier
File unique identifier
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).
https://api.figshare.com/v2/account/articles/{article_id}/files
POST
Article unique identifier
Get Own Articles
https://api.figshare.com/v2/account/articles
GET
Page number. Used for pagination with page_size
The number of results included on a page. Used for pagination with page
Number of results included on a page. Used for pagination with query
Where to start the listing(the offset of the first result). Used for pagination with limit
Returns a list of private articles filtered by the search parameters
https://api.figshare.com/v2/account/articles/search
POST
Search Parameters