Raw schema
{
"type": "object",
"properties": {
"orcid_id": {
"type": "string",
"pattern": "^(?:(?:https?:\\/\\/)?(?:www\\.)?orcid\\.org\\/)?\\d{4}-\\d{4}-\\d{4}-\\d{3}[\\dXx]\\/?$",
"description": "ORCID iD โ bare (0000-0001-2345-6789) or as an orcid.org URI (https://orcid.org/0000-0001-2345-6789). The check digit may be X or x."
},
"work_types": {
"description": "Keep only works of these types, matched against each workType (e.g. [\"journal-article\", \"preprint\"]; ORCID spells datasets data-set). Any listed type matches; an empty list keeps every type.",
"type": "array",
"items": {
"type": "string",
"enum": [
"annotation",
"artistic-performance",
"blog-post",
"book-chapter",
"book-review",
"book",
"cartographic-material",
"clinical-study",
"conference-abstract",
"conference-output",
"conference-paper",
"conference-poster",
"conference-presentation",
"conference-proceedings",
"data-management-plan",
"data-set",
"design",
"dictionary-entry",
"disclosure",
"dissertation-thesis",
"edited-book",
"encyclopedia-entry",
"image",
"invention",
"journal-article",
"journal-issue",
"learning-object",
"lecture-speech",
"license",
"magazine-article",
"manual",
"moving-image",
"musical-composition",
"newsletter-article",
"newspaper-article",
"online-resource",
"other",
"patent",
"physical-object",
"preprint",
"registered-copyright",
"report",
"research-technique",
"research-tool",
"review",
"software",
"sound",
"spin-off-company",
"standards-and-policy",
"supervised-student-publication",
"technical-standard",
"test",
"trademark",
"transcription",
"translation",
"website",
"working-paper",
"undefined"
],
"description": "A work type in ORCID's vocabulary."
}
},
"year_from": {
"description": "Keep only works published in or after this year, read from the first four digits of publicationDate. Under either year bound, works with no publication date are left out and counted in the notice.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"year_to": {
"description": "Keep only works published in or before this year; not before year_from.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"limit": {
"default": 25,
"description": "Works per page. Default 25; a larger value returns at most 1,000 and says so.",
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"offset": {
"default": 0,
"description": "Zero-based index of the first matching work to return (default 0). Continue with nextOffset.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"include_external_ids": {
"default": true,
"description": "When true (default), each work carries its external identifiers (DOIs, PMIDs, arXiv IDs, ISBNs). Set false to omit them for a lighter payload when only titles, types, and dates are needed.",
"type": "boolean"
}
},
"required": [
"orcid_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}