v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB

projects

Private Projects search

Search inside the private projects

post/account/projects/search

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