This is the API

accountArticleReport


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

URL

https://api.figshare.com/v2/account/articles/export

HTTP Method

GET

Response Type

List

Parameters

accountArticleReportGenerate


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

URL

https://api.figshare.com/v2/account/articles/export

HTTP Method

POST

Response Type

AccountReport

Parameters

articleDetails


View an article

URL

https://api.figshare.com/v2/articles/{article_id}

HTTP Method

GET

Response Type

ArticleComplete

Parameters

articleFileDetails


File by id

URL

https://api.figshare.com/v2/articles/{article_id}/files/{file_id}

HTTP Method

GET

Response Type

PublicFile

Parameters

articleFiles


Files list for article

URL

https://api.figshare.com/v2/articles/{article_id}/files

HTTP Method

GET

Response Type

List

Parameters

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.

URL

https://api.figshare.com/v2/articles/{article_id}/versions/{v_number}/confidentiality

HTTP Method

GET

Response Type

ArticleConfidentiality

Parameters

articleVersionDetails


Article with specified version

URL

https://api.figshare.com/v2/articles/{article_id}/versions/{v_number}

HTTP Method

GET

Response Type

ArticleComplete

Parameters

articleVersionEmbargo


Embargo for article version

URL

https://api.figshare.com/v2/articles/{article_id}/versions/{v_number}/embargo

HTTP Method

GET

Response Type

ArticleEmbargo

Parameters

articleVersionUpdate


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

URL

https://api.figshare.com/v2/account/articles/{article_id}/versions/{version_id}/

HTTP Method

PUT

Response Type

LocationWarningsUpdate

Parameters

articleVersionUpdateThumb


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

URL

https://api.figshare.com/v2/account/articles/{article_id}/versions/{version_id}/update_thumb

HTTP Method

PUT

Response Type

Parameters

articleVersions


List public article versions

URL

https://api.figshare.com/v2/articles/{article_id}/versions

HTTP Method

GET

Response Type

List

Parameters

articlesList


Returns a list of public articles

URL

https://api.figshare.com/v2/articles

HTTP Method

GET

Response Type

List

Parameters

articlesSearch


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

URL

https://api.figshare.com/v2/articles/search

HTTP Method

POST

Response Type

List

Parameters

privateArticleAuthorDelete


De-associate author from article

URL

https://api.figshare.com/v2/account/articles/{article_id}/authors/{author_id}

HTTP Method

DELETE

Response Type

Parameters

privateArticleAuthorsAdd


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

URL

https://api.figshare.com/v2/account/articles/{article_id}/authors

HTTP Method

POST

Response Type

Parameters

privateArticleAuthorsList


List article authors

URL

https://api.figshare.com/v2/account/articles/{article_id}/authors

HTTP Method

GET

Response Type

List

Parameters

privateArticleAuthorsReplace


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

URL

https://api.figshare.com/v2/account/articles/{article_id}/authors

HTTP Method

PUT

Response Type

Parameters

privateArticleCategoriesAdd


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

URL

https://api.figshare.com/v2/account/articles/{article_id}/categories

HTTP Method

POST

Response Type

Parameters

privateArticleCategoriesList


List article categories

URL

https://api.figshare.com/v2/account/articles/{article_id}/categories

HTTP Method

GET

Response Type

List

Parameters

privateArticleCategoriesReplace


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

URL

https://api.figshare.com/v2/account/articles/{article_id}/categories

HTTP Method

PUT

Response Type

Parameters

privateArticleCategoryDelete


De-associate category from article

URL

https://api.figshare.com/v2/account/articles/{article_id}/categories/{category_id}

HTTP Method

DELETE

Response Type

Parameters

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.

URL

https://api.figshare.com/v2/account/articles/{article_id}/confidentiality

HTTP Method

DELETE

Response Type

Parameters

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.

URL

https://api.figshare.com/v2/account/articles/{article_id}/confidentiality

HTTP Method

GET

Response Type

ArticleConfidentiality

Parameters

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.

URL

https://api.figshare.com/v2/account/articles/{article_id}/confidentiality

HTTP Method

PUT

Response Type

Parameters

privateArticleCreate


Create a new Article by sending article information

URL

https://api.figshare.com/v2/account/articles

HTTP Method

POST

Response Type

LocationWarnings

Parameters

privateArticleDelete


Delete an article

URL

https://api.figshare.com/v2/account/articles/{article_id}

HTTP Method

DELETE

Response Type

Parameters

privateArticleDetails


View a private article

URL

https://api.figshare.com/v2/account/articles/{article_id}

HTTP Method

GET

Response Type

ArticleCompletePrivate

Parameters

privateArticleEmbargoDelete


Will lift the embargo for the specified article

URL

https://api.figshare.com/v2/account/articles/{article_id}/embargo

HTTP Method

DELETE

Response Type

Parameters

privateArticleEmbargoDetails


View a private article embargo details

URL

https://api.figshare.com/v2/account/articles/{article_id}/embargo

HTTP Method

GET

Response Type

ArticleEmbargo

Parameters

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.

URL

https://api.figshare.com/v2/account/articles/{article_id}/embargo

HTTP Method

PUT

Response Type

Parameters

privateArticleFile


View details of file for specified article

URL

https://api.figshare.com/v2/account/articles/{article_id}/files/{file_id}

HTTP Method

GET

Response Type

PrivateFile

Parameters

privateArticleFileDelete


Complete file upload

URL

https://api.figshare.com/v2/account/articles/{article_id}/files/{file_id}

HTTP Method

DELETE

Response Type

Parameters

privateArticleFilesList


List private files

URL

https://api.figshare.com/v2/account/articles/{article_id}/files

HTTP Method

GET

Response Type

List

Parameters

privateArticlePrivateLink


List private links

URL

https://api.figshare.com/v2/account/articles/{article_id}/private_links

HTTP Method

GET

Response Type

List

Parameters

privateArticlePrivateLinkCreate


Create new private link for this article

URL

https://api.figshare.com/v2/account/articles/{article_id}/private_links

HTTP Method

POST

Response Type

PrivateLinkResponse

Parameters

privateArticlePrivateLinkDelete


Disable/delete private link for this article

URL

https://api.figshare.com/v2/account/articles/{article_id}/private_links/{link_id}

HTTP Method

DELETE

Response Type

Parameters

privateArticlePrivateLinkUpdate


Update existing private link for this article

URL

https://api.figshare.com/v2/account/articles/{article_id}/private_links/{link_id}

HTTP Method

PUT

Response Type

Parameters

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.

URL

https://api.figshare.com/v2/account/articles/{article_id}/publish

HTTP Method

POST

Response Type

Location

Parameters

privateArticleReserveDoi


Reserve DOI for article

URL

https://api.figshare.com/v2/account/articles/{article_id}/reserve_doi

HTTP Method

POST

Response Type

ArticleDOI

Parameters

privateArticleReserveHandle


Reserve Handle for article

URL

https://api.figshare.com/v2/account/articles/{article_id}/reserve_handle

HTTP Method

POST

Response Type

ArticleHandle

Parameters

privateArticleResource


Edit article resource data.

URL

https://api.figshare.com/v2/account/articles/{article_id}/resource

HTTP Method

POST

Response Type

Location

Parameters

privateArticleUpdate


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

URL

https://api.figshare.com/v2/account/articles/{article_id}

HTTP Method

PUT

Response Type

LocationWarningsUpdate

Parameters

privateArticleUploadComplete


Complete file upload

URL

https://api.figshare.com/v2/account/articles/{article_id}/files/{file_id}

HTTP Method

POST

Response Type

Parameters

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

URL

https://api.figshare.com/v2/account/articles/{article_id}/files

HTTP Method

POST

Response Type

Location

Parameters

privateArticlesList


Get Own Articles

URL

https://api.figshare.com/v2/account/articles

HTTP Method

GET

Response Type

List

Parameters

privateArticlesSearch


Returns a list of private articles filtered by the search parameters

URL

https://api.figshare.com/v2/account/articles/search

HTTP Method

POST

Response Type

List

Parameters