Sign in

v2

OpenAPI 3.1.0CC02026-07-264460181.4 KB
Works

Get a single work

Retrieve a single work by its OpenAlex ID or external ID (DOI, PMID, PMCID, MAG ID). External IDs can be passed as full URLs or URN format (e.g., doi:10.1234/example or pmid:12345678).

get/works/{id}

Path parameters

idstring required

OpenAlex ID (e.g., W2741809807) or external ID (DOI, PMID, PMCID, MAG)

Query parameters

selectstring

Comma-separated list of fields to return. Reduces response size. Example: select=id,display_name,cited_by_count

api_keystring required

Your OpenAlex API key (required). Get a free key at https://openalex.org/settings/api

Response

Successful response

idstring

The OpenAlex ID for this work.

doistring nullable

The DOI for the work. This is the Canonical External ID for works.

titlestring nullable

The title of this work.

display_namestring

Same as title. Included for consistency with other entities.

publication_yearinteger nullable

The year this work was published.

publication_datestring date nullable

The day when this work was published (ISO 8601 format).

typestring

The type of the work. Common values: article, book, dataset, preprint, dissertation, book-chapter.

languagestring nullable

Language in ISO 639-1 format

cited_by_countinteger

The number of citations to this work.

is_retractedboolean

True if this work has been retracted (from Retraction Watch database).

is_paratextboolean

True if this work is paratext (e.g., front cover, table of contents).

abstract_inverted_indexobject nullable

The abstract as an inverted index (word positions). OpenAlex doesn't include plaintext abstracts due to legal constraints. Use the has_abstract filter to get works with or without abstracts.

referenced_worksstring[]

OpenAlex IDs for works that this work cites.

referenced_works_countinteger

The number of works that this work cites.

related_worksstring[]

OpenAlex IDs for works related to this work (computed algorithmically).

fwcinumber nullable

Field-weighted Citation Impact, calculated as citations received / citations expected.

indexed_instring[]

Sources this work is indexed in. Values: arxiv, crossref, doaj, pubmed.

content_urlstring nullable

URL for downloading full-text content. Only present when has_content.pdf or has_content.grobid_xml is true.

created_datestring date

When this work was added to OpenAlex (ISO 8601 date).

updated_datestring date-time

When this work was last updated (ISO 8601 datetime).

Example response

{
  "id": "https://openalex.org/W2741809807",
  "doi": "https://doi.org/10.7717/peerj.4375"
}