v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB

collections

Private Collections List

List private collections

get/account/collections

Query parameters

pageinteger

Page number. Used for pagination with page_size

page_sizeinteger

The number of results included on a page. Used for pagination with page

limitinteger

Number of results included on a page. Used for pagination with query

offsetinteger

Where to start the listing (the offset of the first result). Used for pagination with limit

order'published_date' | 'modified_date' | 'views' | 'shares' | 'cites'

The field by which to order. Default varies by endpoint/resource.

order_direction'asc' | 'desc'

Response

OK. An array of collections

idinteger required

Collection id

titlestring required

Collection title

doistring required

Collection DOI

handlestring required

Collection Handle

urlstring required

Api endpoint

published_datestring

Date when collection was first published, null if not published

Example response

[
  {
    "id": 123,
    "title": "Sample collection",
    "doi": "10.6084/m9.figshare.123",
    "handle": "111184/figshare.1234",
    "url": "https://api.figshare.com/v2/collections/123",
    "timeline": {
      "firstOnline": "2015-12-31",
      "publisherPublication": "2015-12-31",
      "publisherAcceptance": "2015-12-31"
    },
    "published_date": "2017-05-15T15:12:26Z"
  }
]