v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB

projects

Public Projects

Returns a list of public projects

get/projects

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'

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

order_direction'asc' | 'desc'

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

groupinteger

only return collections from this group

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.

Response

OK. An array of projects

urlstring required

Api endpoint

idinteger required

Project id

titlestring required

Project title

created_datestring required

Date when project was created

modified_datestring required

Date when project was last modified

published_datestring

Date when project was first published, null if not published

Example response

[
  {
    "url": "http://api.figshare.com/v2/account/projects/1",
    "id": 1,
    "title": "project",
    "created_date": "2017-05-16T14:52:54Z",
    "modified_date": "2017-05-16T14:52:54Z",
    "published_date": "2017-05-16T14:52:54Z"
  }
]