← Back to catalog

Other

Figshare

auto-generated
swirls add figshare
actionGETv1.0.0

Account Article Report

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

Source
actionPOSTv1.0.0

Add article authors

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

Source
actionPOSTv1.0.0

Add article categories

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

Source
actionPOSTv1.0.0

Add collection articles

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

Source
actionPOSTv1.0.0

Add collection authors

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

Source
actionPOSTv1.0.0

Add collection categories

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

Source
actionGETv1.0.0

Article confidentiality details

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.

Source
actionPOSTv1.0.0

Create collection

Create a new Collection by sending collection information

Source
actionPOSTv1.0.0

Create new Article

Create a new Article by sending article information

Source
actionPOSTv1.0.0

Create private link

Create new private link for this article

Source
actionPOSTv1.0.0

Create project article

Create a new Article and associate it with this project

Source
actionDELETEv1.0.0

Delete article confidentiality

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.

Source
actionDELETEv1.0.0

Delete Article Embargo

Will lift the embargo for the specified article

Source
actionDELETEv1.0.0

Delete project

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.

Source
actionPOSTv1.0.0

Initiate a new Report

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

Source
actionGETv1.0.0

Item Types

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

Source
actionGETv1.0.0

Private Account Institution Groups

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

Source
actionGETv1.0.0

Private Account Licenses

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

Source
actionPOSTv1.0.0

Private Article Publish

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

Source
actionPOSTv1.0.0

Private Articles search

Returns a list of private articles filtered by the search parameters

Source
actionPOSTv1.0.0

Private Collection Publish

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.

Source
actionPOSTv1.0.0

Public Articles Search

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

Source
actionGETv1.0.0

Public Licenses

Returns a list of articles belonging to the institution

Source
actionGETv1.0.0

Single File

View details of file for specified article

Source
actionPUTv1.0.0

Update article

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

Source
actionPUTv1.0.0

Update article confidentiality

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.

Source
actionPUTv1.0.0

Update Article Embargo

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.

Source
actionPUTv1.0.0

Update collection

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

Source
actionPUTv1.0.0

Update private link

Update existing private link for this article

Source
actionPUTv1.0.0

Update project

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

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec