This is the API

collectionArticles


Returns a list of public collection articles

URL

https://api.figshare.com/v2/collections/{collection_id}/articles

HTTP Method

GET

Response Type

List

Parameters

collectionDetails


View a collection

URL

https://api.figshare.com/v2/collections/{collection_id}

HTTP Method

GET

Response Type

CollectionComplete

Parameters

collectionVersionDetails


View details for a certain version of a collection

URL

https://api.figshare.com/v2/collections/{collection_id}/versions/{version_id}

HTTP Method

GET

Response Type

CollectionComplete

Parameters

collectionVersions


Returns a list of public collection Versions

URL

https://api.figshare.com/v2/collections/{collection_id}/versions

HTTP Method

GET

Response Type

List

Parameters

collectionsList


Returns a list of public collections

URL

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

HTTP Method

GET

Response Type

List

Parameters

collectionsSearch


Returns a list of public collections

URL

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

HTTP Method

POST

Response Type

List

Parameters

privateCollectionArticleDelete


De-associate article from collection

URL

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

HTTP Method

DELETE

Response Type

Parameters

privateCollectionArticlesAdd


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

URL

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

HTTP Method

POST

Response Type

Location

Parameters

privateCollectionArticlesList


List collection articles

URL

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

HTTP Method

GET

Response Type

List

Parameters

privateCollectionArticlesReplace


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

URL

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

HTTP Method

PUT

Response Type

Parameters

privateCollectionAuthorDelete


Delete collection author

URL

https://api.figshare.com/v2/account/collections/{collection_id}/authors/{author_id}

HTTP Method

DELETE

Response Type

Parameters

privateCollectionAuthorsAdd


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

URL

https://api.figshare.com/v2/account/collections/{collection_id}/authors

HTTP Method

POST

Response Type

Location

Parameters

privateCollectionAuthorsList


List collection authors

URL

https://api.figshare.com/v2/account/collections/{collection_id}/authors

HTTP Method

GET

Response Type

List

Parameters

privateCollectionAuthorsReplace


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

URL

https://api.figshare.com/v2/account/collections/{collection_id}/authors

HTTP Method

PUT

Response Type

Parameters

privateCollectionCategoriesAdd


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

URL

https://api.figshare.com/v2/account/collections/{collection_id}/categories

HTTP Method

POST

Response Type

Location

Parameters

privateCollectionCategoriesList


List collection categories

URL

https://api.figshare.com/v2/account/collections/{collection_id}/categories

HTTP Method

GET

Response Type

List

Parameters

privateCollectionCategoriesReplace


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

URL

https://api.figshare.com/v2/account/collections/{collection_id}/categories

HTTP Method

PUT

Response Type

Parameters

privateCollectionCategoryDelete


De-associate category from collection

URL

https://api.figshare.com/v2/account/collections/{collection_id}/categories/{category_id}

HTTP Method

DELETE

Response Type

Parameters

privateCollectionCreate


Create a new Collection by sending collection information

URL

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

HTTP Method

POST

Response Type

LocationWarnings

Parameters

privateCollectionDelete


Delete n collection

URL

https://api.figshare.com/v2/account/collections/{collection_id}

HTTP Method

DELETE

Response Type

Parameters

privateCollectionDetails


View a collection

URL

https://api.figshare.com/v2/account/collections/{collection_id}

HTTP Method

GET

Response Type

CollectionCompletePrivate

Parameters

privateCollectionPrivateLinkCreate


Create new private link

URL

https://api.figshare.com/v2/account/collections/{collection_id}/private_links

HTTP Method

POST

Response Type

PrivateLinkResponse

Parameters

privateCollectionPrivateLinkDelete


Disable/delete private link for this collection

URL

https://api.figshare.com/v2/account/collections/{collection_id}/private_links/{link_id}

HTTP Method

DELETE

Response Type

Parameters

privateCollectionPrivateLinkUpdate


Update existing private link for this collection

URL

https://api.figshare.com/v2/account/collections/{collection_id}/private_links/{link_id}

HTTP Method

PUT

Response Type

Parameters

privateCollectionPrivateLinksList


List article private links

URL

https://api.figshare.com/v2/account/collections/{collection_id}/private_links

HTTP Method

GET

Response Type

List

Parameters

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.

URL

https://api.figshare.com/v2/account/collections/{collection_id}/publish

HTTP Method

POST

Response Type

Location

Parameters

privateCollectionReserveDoi


Reserve DOI for collection

URL

https://api.figshare.com/v2/account/collections/{collection_id}/reserve_doi

HTTP Method

POST

Response Type

CollectionDOI

Parameters

privateCollectionReserveHandle


Reserve Handle for collection

URL

https://api.figshare.com/v2/account/collections/{collection_id}/reserve_handle

HTTP Method

POST

Response Type

CollectionHandle

Parameters

privateCollectionResource


Edit collection resource data.

URL

https://api.figshare.com/v2/account/collections/{collection_id}/resource

HTTP Method

POST

Response Type

Location

Parameters

privateCollectionUpdate


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

URL

https://api.figshare.com/v2/account/collections/{collection_id}

HTTP Method

PUT

Response Type

LocationWarningsUpdate

Parameters

privateCollectionsList


List private collections

URL

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

HTTP Method

GET

Response Type

List

Parameters

privateCollectionsSearch


Returns a list of private Collections

URL

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

HTTP Method

POST

Response Type

List

Parameters