This is the API
Returns a list of public collection articles
https://api.figshare.com/v2/collections/{collection_id}/articles
GET
Collection Unique identifier
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
View a collection
https://api.figshare.com/v2/collections/{collection_id}
GET
Collection Unique identifier
View details for a certain version of a collection
https://api.figshare.com/v2/collections/{collection_id}/versions/{version_id}
GET
Collection Unique identifier
Version Number
Returns a list of public collection Versions
https://api.figshare.com/v2/collections/{collection_id}/versions
GET
Collection Unique identifier
Returns a list of public collections
https://api.figshare.com/v2/collections
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 collections from this institution
Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD
Filter by collection modified date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD
only return collections from this group
only return collections with this resource_doi
only return collections with this doi
only return collections with this handle
Returns a list of public collections
https://api.figshare.com/v2/collections/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 article from collection
https://api.figshare.com/v2/account/collections/{collection_id}/articles/{article_id}
DELETE
Collection unique identifier
Collection article unique identifier
Associate new articles with the collection. This will add new articles to the list of already associated articles
https://api.figshare.com/v2/account/collections/{collection_id}/articles
POST
Collection unique identifier
Articles list
List collection articles
https://api.figshare.com/v2/account/collections/{collection_id}/articles
GET
Collection unique identifier
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
Associate new articles with the collection. This will remove all already associated articles and add these new ones
https://api.figshare.com/v2/account/collections/{collection_id}/articles
PUT
Collection unique identifier
Articles List
Delete collection author
https://api.figshare.com/v2/account/collections/{collection_id}/authors/{author_id}
DELETE
Collection unique identifier
Collection Author unique identifier
Associate new authors with the collection. This will add new authors to the list of already associated authors
https://api.figshare.com/v2/account/collections/{collection_id}/authors
POST
Collection unique identifier
List of authors
List collection authors
https://api.figshare.com/v2/account/collections/{collection_id}/authors
GET
Collection unique identifier
Associate new authors with the collection. This will remove all already associated authors and add these new ones
https://api.figshare.com/v2/account/collections/{collection_id}/authors
PUT
Collection unique identifier
List of authors
Associate new categories with the collection. This will add new categories to the list of already associated categories
https://api.figshare.com/v2/account/collections/{collection_id}/categories
POST
Collection unique identifier
Categories list
List collection categories
https://api.figshare.com/v2/account/collections/{collection_id}/categories
GET
Collection unique identifier
Associate new categories with the collection. This will remove all already associated categories and add these new ones
https://api.figshare.com/v2/account/collections/{collection_id}/categories
PUT
Collection unique identifier
Categories list
De-associate category from collection
https://api.figshare.com/v2/account/collections/{collection_id}/categories/{category_id}
DELETE
Collection unique identifier
Collection category unique identifier
Create a new Collection by sending collection information
https://api.figshare.com/v2/account/collections
POST
Collection description
Delete n collection
https://api.figshare.com/v2/account/collections/{collection_id}
DELETE
Collection Unique identifier
View a collection
https://api.figshare.com/v2/account/collections/{collection_id}
GET
Collection Unique identifier
Create new private link
https://api.figshare.com/v2/account/collections/{collection_id}/private_links
POST
Collection unique identifier
Disable/delete private link for this collection
https://api.figshare.com/v2/account/collections/{collection_id}/private_links/{link_id}
DELETE
Collection unique identifier
Private link token
Update existing private link for this collection
https://api.figshare.com/v2/account/collections/{collection_id}/private_links/{link_id}
PUT
Collection unique identifier
Private link token
List article private links
https://api.figshare.com/v2/account/collections/{collection_id}/private_links
GET
Collection unique identifier
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.
https://api.figshare.com/v2/account/collections/{collection_id}/publish
POST
Collection Unique identifier
Reserve DOI for collection
https://api.figshare.com/v2/account/collections/{collection_id}/reserve_doi
POST
Collection Unique identifier
Reserve Handle for collection
https://api.figshare.com/v2/account/collections/{collection_id}/reserve_handle
POST
Collection Unique identifier
Edit collection resource data.
https://api.figshare.com/v2/account/collections/{collection_id}/resource
POST
Collection unique identifier
Resource data
Update collection details; request can also be made with the PATCH method.
https://api.figshare.com/v2/account/collections/{collection_id}
PUT
Collection Unique identifier
Collection description
List private collections
https://api.figshare.com/v2/account/collections
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
The field by which to order. Default varies by endpoint/resource.
Returns a list of private Collections
https://api.figshare.com/v2/account/collections/search
POST
Search Parameters