Skip to main content
Version: Next

Persons

Search and retrieve persons — authors and contributors involved in research products.

Base URL​

https://api.openaire.eu/graph/v3/persons

Quick start​

Search for a person by name:

/v3/persons?givenName=Paolo&lastName=Manghi

Retrieve a single person by their OpenAIRE id:

/v3/persons/orcid_______::9caf6084c49220d309b7cdf46c61c2e3

Endpoints​

  • GET /v3/persons — search persons using the filter parameters below
  • GET /v3/persons/{id} — retrieve a single person by their OpenAIRE id

Filter parameters​

ParameterDescription
searchKeyword-based search across the person's content.
idThe OpenAIRE id of the person.
originalIdThe identifier of the record at the original sources.
pidThe persistent identifier of the person (e.g. an ORCID).
givenNameThe given name of the person.
lastNameThe last name of the person.
relProjectIdPersons connected to the project (with OpenAIRE id).
relProjectPersons connected to the project.
relOrganizationIdPersons connected to the organization (with OpenAIRE id).
relOrganizationPersons connected to the organization name.

All filter parameters support the AND, OR, and NOT logical operators. See filtering research products for details on the operator syntax.

Meta-parameters​

ParameterTypeDefaultDescription
logicalOperatorstringANDTop-level operator combining the provided filters (AND or OR)
sortBystringrelevance DESCSort directive fieldname ASC\|DESC. Persons can only be sorted by relevance.
pageint1Page number
pageSizeint10Results per page, range 1–100
cursorstring—Cursor-based pagination, initial value *

For paging through results, see Paging.

Response​

The response is an object with a header and a results array. The header reports numFound, queryTime, page, pageSize, maxScore (only when ranking by relevance), and nextCursor (cursor paging). The results array contains Person objects.

Examples​

Common / top-level parameters​

ParameterExample
search?search=Manghi
sortBy?search=Manghi&sortBy=relevance DESC
logicalOperator?givenName=Paolo&lastName=Manghi&logicalOperator=OR
page + pageSize?lastName=Smith&page=2&pageSize=25
cursor?lastName=Smith&pageSize=100&cursor=*

Identity​

ParameterExample
id?id=orcid_______::1162aa0085201f2b835315dae4e5a827
originalId?originalId=0000-0002-1825-0097
pid?pid=0000-0001-7291-3210

Name​

ParameterExample
givenName?givenName=Paolo
lastName?lastName=Manghi
lastName (OR / NOT)?lastName=("Manghi" OR "Smith") AND NOT "Jones"
ParameterExample
relProjectId?relProjectId=corda__h2020::2f32bdaa3c76066bd8267f3ac90ba898
relProject?relProject="corda__h2020::2f32bdaa3c76066bd8267f3ac90ba898||OpenAIRE Nexus"
relOrganizationId?relOrganizationId=openorgs____::d41cf6bd4ab1b1362a44397e0b95c975
relOrganization?relOrganization="openorgs____::d41cf6bd4ab1b1362a44397e0b95c975||National Research Council"
note

The relProject and relOrganization filters match on a composite id||name value — see the equivalent research product filters for the same pattern.

Combined examples​

ParameterExample
Full name match?givenName=Paolo&lastName=Manghi
By ORCID, paged?originalId=0000-0002-1825-0097&pageSize=10