Works

GET /works

Returns a list of all works (journal articles, conference proceedings, books, components, etc), 20 per page by default.

In addition to the query parameter, this endpoint supports the following <a href="#queries">field queries</a>:

  • query.affiliation - query contributor affiliations
  • query.author - query author given and family names
  • query.bibliographic - query bibliographic information, useful for citation look up, includes titles, authors, ISSNs and publication years
  • query.chair - query chair given and family names
  • query.container-title - query container title aka. publication name
  • query.contributor - query author, editor, chair and translator given and family names
  • query.degree - query degree
  • query.description - query description
  • query.editor - query editor given and family names
  • query.event-acronym - query acronym of the event
  • query.event-location - query location of the event
  • query.event-name - query name of the event
  • query.event-sponsor - query sponsor of the event
  • query.event-theme - query theme of the event
  • query.funder-name - query name of the funder
  • query.publisher-location - query location of the publisher
  • query.publisher-name - query publisher name
  • query.standards-body-acronym - query acronym of the standards body
  • query.standards-body-name - query standards body name
  • query.title - query title
  • query.translator - query translator given and family names

sort: <a href="#sort">Sorting</a> by the following fields is supported:

citation created deposited indexed is-referenced-by-count issued published published-online published-print references-count relevance score updated .

Note that the following types of sorting cannot be combined with a cursor: issued, published, published-print, published-online.

facet: This endpoint supports the following <a href="#facets">facets</a>:

  • affiliation - author affiliation
  • archive - archive location
  • assertion - custom Crossmark assertion name
  • assertion-group - custom Crossmark assertion group name
  • category-name - category name of work
  • container-title - [max value 100], work container title, such as journal title, or book title
  • funder-doi - funder DOI
  • funder-name - funder name as deposited it appears in a metadata record
  • issn - [max value 100], journal ISSN (any - print, electronic, link)
  • journal-issue - journal issue number
  • journal-volume - journal volume
  • license - license URI of work
  • link-application - intended application of the full text link
  • orcid - [max value 100], contributor ORCID
  • published - earliest year of publication
  • publisher-name - publisher name of work
  • relation-type - relation type described by work or described by another work with work as object
  • ror-id - institution ROR ID
  • source - source of the DOI
  • type-name - work type name, such as journal-article or book-chapter
  • update-type - significant update type

filter: See our documentation website for a full list of available filters.

select: You can <a href="#select">select</a> any of the following fields:

DOI ISBN ISSN URL abstract accepted alternative-id approved archive article-number assertion author chair clinical-trial-number container-title content-created content-domain contributor created degree deposited editor event funder group-title indexed is-referenced-by-count issn-type issue issued license link member original-title page posted prefix published published-online published-print publisher publisher-location reference references-count relation resource score short-container-title short-title standards-body subject subtitle title translator type update-policy update-to updated-by volume

Request

Query parameters

rowsinteger

The number of rows per page of results

orderstring

Specify the order of sorted results, e.g. asc or desc (default).

facetstring

Retrieve counts for pre-defined facets e.g. type-name:* returns counts of all works by type. See <a href='#facets'>Facets</a>.

sampleinteger

Retrieve N randomly sampled items

sortstring

Sort results by a certain field. See <a href='#sort'>Sorting</a>.

offsetinteger

The number of rows to skip before returning. See <a href='#cursors'>Retrieving large results sets</a>.

mailtostring

The email address to identify yourself and access the 'polite pool'

selectstring

Select certain fields, supports a comma separated list of fields. See <a href='#select'>Select response fields</a>

querystring

Query certain fields. See <a href='#queries'>Queries</a>.

filterstring

Filter by certain fields. See <a href='#filters'>filters</a>

cursorstring

Page through large result sets. See <a href='#cursors'>Retrieving large results sets</a>.

Response

A list of works

statusstring required
message-typestring required
message-versionstring required

Changes

No recorded changes to this operation across all 1 revision of this API.