FIfigshare
collections

Private Collections Search

Changed on

Returns a list of private Collections

post/account/collections/search

Request

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

Changes

  • 7dd8ffee0fafRevision changes
    • info

      added the optional property / to the response with the status

  • 5806e3dd43b2Revision changes
    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status