Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB
collections

Public Collections Search

Returns a list of public collections

post/collections/search

Headers

X-Cursorstring

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.

Request body

search_forstring

Search term

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_direction'asc' | 'desc'

Direction of ordering

institutioninteger

only return collections from this institution

published_sincestring

Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ

modified_sincestring

Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ

groupinteger

only return collections from this group

Example request

{
  "search_for": "figshare",
  "page": 1,
  "page_size": 10,
  "limit": 10,
  "order_direction": "desc",
  "institution": 2000013,
  "published_since": "2017-12-22",
  "modified_since": "2017-12-22",
  "group": 2000013
}

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"
  }
]