Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB
articles

Private Articles search

Returns a list of private articles filtered by the search parameters

post/account/articles/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 articles

idinteger required

Unique identifier for article

titlestring required

Title of article

doistring required

DOI

handlestring required

Handle

urlstring url required

Api endpoint for article

url_public_htmlstring url required

Public site endpoint for article

url_public_apistring url required

Public Api endpoint for article

url_private_htmlstring url required

Private site endpoint for article

url_private_apistring url required

Private Api endpoint for article

thumbstring url required

Thumbnail image

defined_typeinteger required

Type of article identifier

defined_type_namestring required

Name of the article type identifier

resource_doistring required

Deprecated by related materials. Not applicable to regular users. In a publisher case, this is the publisher article DOI.

resource_titlestring required

Deprecated by related materials. Not applicable to regular users. In a publisher case, this is the publisher article title.

created_datestring required

Date when article was created

modified_datestring

Date when article was last modified

published_datestring

Date when article was first published, null if not published

group_idinteger

Group ID of the article

Example response

[
  {
    "id": 1434614,
    "title": "Test article title",
    "doi": "10.6084/m9.figshare.1434614",
    "handle": "111184/figshare.1234",
    "url": "http://api.figshare.com/articles/1434614",
    "url_public_html": "https://figshare.com/articles/media/Test_article_title/1434614",
    "url_public_api": "https://api.figshare.com/articles/1434614",
    "url_private_html": "https://figshare.com/account/articles/1434614",
    "url_private_api": "https://api.figshare.com/account/articles/1434614",
    "timeline": {
      "firstOnline": "2015-12-31",
      "publisherPublication": "2015-12-31",
      "publisherAcceptance": "2015-12-31"
    },
    "thumb": "https://ndownloader.figshare.com/files/123456789/preview/12345678/thumb.png",
    "defined_type": 3,
    "defined_type_name": "media",
    "created_date": "2017-05-18T11:49:03Z",
    "modified_date": "2017-05-18T11:49:03Z",
    "published_date": "2017-05-18T11:49:03Z",
    "group_id": 1
  }
]