The ORCID search API uses the SOLR syntax. All query syntaxes available in SOLR 3.6 are supported, including Lucene with Solr extensions (default), DisMax, and Extended Dismax.
You can use a fielded search when you need to search a specific section of the ORCID record. The current list of fields recognized in the API search, along with their corresponding record structure elements, are as follows:
| Search field | Description |
| Biographical data | |
| given-names | The given (first) name(s) of the user. |
| family-name | The family (sur)name of the user. |
| credit-name | The “published name” on the ORCID user interface, the name that normally appears on publications by the user |
| other-names | Alternative names that may have appeared on publications by the user. |
| The email address of the user. | |
| keyword | Any keywords associated with the user. |
| external-id-reference | Identifiers from other systems added to the user‚s ORCID record using the API. |
| Affiliations data | |
| affiliation-org-name | The name of any organization in an education or employment item in the user’s record. |
| grid-org-id | The GRID ID of any organization in the activities section of the user’s record. Generally this will be associated with an education or employment item. |
| ror-org-id | The ROR ID of any organization in the activities section of the user’s record. Generally this will be associated with an education or employment item. |
| ringgold-org-id | The Ringgold ID* of any organization in the activities section of the user’s record. Generally this will be associated with an education or employment item. |
| Funding data | |
| funding-titles | The title of any funding item in the user‚s record. |
| fundref-org-id | The Crossref Funder Registry ID of any organization in the activities section of a user‚s record. Generally this will be associated with a funding item, but it may also be associated with an affiliation. |
| grant-numbers | Grant number (identifier) of any funding item in the user’s record. |
| Research activities data | |
| work-titles | The titles of any work in the user’s record. |
| digital-object-ids | A work external identifier with type doi |
| doi-self | A work external identifier with type doi and the external identifier relationship set to self |
| [external identifier type]* | A work external identifier with the given type |
| [external identifier type]*-self | A work external identifier with the given type and the external identifier relationship set to self |
| [external identifier type]*-part-of | A work external identifier with the given type and the external identifier relationship set to part-of |
| [external identifier type]*-version-of | A work external identifier with the given type and the external identifier relationship set to version-of * For a full list of external identifier see the identifiers list. Some identifiers may require “-self” “-part-of” or “-version-of” to return results |
| ORCID record data | |
| orcid | The 16-digit ORCID identifier of the user, in 0000-0001-2345-6789 format. |
| profile-submission-date | The date and time the record was created. |
| profile-last-modified-date | The date and time the record was last modified. |
| All data | |
| text | All the above fields. This is also the default field for Lucene syntax queries. |
See our Search API Tutorial for more information.
*Although Ringgold identifiers still exist within the ORCID registry, as of 1 August 2023, ORCID no longer receives updates to the RINGGOLD organization identifier database used by our Registry, nor will we be able to process or use RINGGOLD IDs created after that date. See our FAQ for more info
1
1