FIfigshare
collections

Collection details

Changed on

View a collection. For collections with item-type based metadata, all core and stock metadata (including title) is returned under a fields object and suppressed at the top level, with relational fields hydrated: authors → [{id, name, first_name, last_name, is_active, url_name, orcid_id, affiliations}], categories → [{id, title, parent_id, path, source_id, taxonomy_id}], funding_list → [{id, title, grant_code, funder_name, is_user_defined, url}] (url only when a dimensions id is present), related_materials → [{id, title, relation, identifier, identifier_type}], publisher returned as-is (string). Collections without item-type based metadata keep the legacy flat shape.

get/account/collections/{collection_id}

Request

Path parameters

collection_idinteger required

Collection Unique identifier

Response

OK. Collection representation

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 5806e3dd43b2Revision changes
    • breaking

      added the new path request parameter collection_id

    • info

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