/orcid/researchers/works

POST /api/orcid/researchers/works

Price: 1 credit

Get the full works of an ORCID researcher by their ORCID iD

How to use it

Get the detailed publications of a researcher from ORCID by their ORCID iD. Returns each work with its title and subtitle, type, journal, publication date, a short description, a formatted citation, language, external identifiers (DOI, ISSN, etc.), links and the list of contributors with their roles.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• orcid string required — ORCID iD of the researcher. Accepts the bare id, a dashed id, or the full orcid.org URL. (examples: "0000-0001-6187-6610", "https://orcid.org/0000-0001-6187-6610"; minLength: 1)
• count integer required — Number of works to return (min: 1)

Response

• @type string (default: "OrcidWork")
• put_code integer nullable
• subtitle string nullable
• type string nullable
• journal_title string nullable
• publication_date string nullable
• short_description string nullable
• citation_type string nullable
• citation string nullable
• language_code string nullable
• country string nullable
• url string nullable
• external_ids array (default: [])
  • @type string (default: "OrcidExternalId")
  • type string nullable
  • value string nullable
  • url string nullable
  • relationship string nullable
• contributors array (default: [])
  • @type string (default: "OrcidWorkContributor")
  • name string nullable
  • orcid string nullable
  • role string nullable
  • sequence string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Researcher not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.