GET /articles

figshare.com

Summary: Public Articles
Operation ID: articles_list
Auth: unknown
Description

Returns a list of public articles

Parameters (15)

X-Cursor (string, header, optional)

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.

doi (string, query, optional)

only return articles with this doi

group (integer, query, optional)

only return articles from this group

handle (string, query, optional)

only return articles with this handle

institution (integer, query, optional)

only return articles from this institution

item_type (integer, query, optional)

Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model

limit (integer, query, optional)

Number of results included on a page. Used for pagination with query

Constraints: {'minimum': 1, 'maximum': 1000}

modified_since (string, query, optional)

Filter by article modified date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD

offset (integer, query, optional)

Where to start the listing(the offset of the first result). Used for pagination with limit

Constraints: {'minimum': 0, 'maximum': 5000}

order (string, query, optional, default: published_date)

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

Constraints: {'enum': ['published_date', 'modified_date', 'views', 'shares', 'downloads', 'cites']}

order_direction (string, query, optional, default: desc)

Constraints: {'enum': ['asc', 'desc']}

page (integer, query, optional)

Page number. Used for pagination with page_size

Constraints: {'minimum': 1, 'maximum': 5000}

page_size (integer, query, optional, default: 10)

The number of results included on a page. Used for pagination with page

Constraints: {'minimum': 1, 'maximum': 1000}

published_since (string, query, optional)

Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD

resource_doi (string, query, optional)

only return articles with this resource_doi

No probe data for this endpoint yet.