Skip to main content
Version: Next

Filtering

All SKG-IF search endpoints take a single required filter parameter.

Syntax​

filter=key1:value1,key2:value2
SeparatorMeaningExample
:Binds a key to its valueproduct_type:literature
,AND across different keysproduct_type:literature,cf.language:English
|OR within one key's valueproduct_type:literature|research data
note

filter is required — a request without it fails. Values containing spaces must be URL-encoded (research%20data).

Convenience filters​

Keys beginning with cf. are convenience filters: OpenAIRE extensions that are not part of the SKG-IF specification. They expose useful Graph capabilities — free-text search, subject and language filtering — that the specification does not define.

Every other key maps to a field defined by SKG-IF; for what a field means, see that entity's page in the Interoperability Framework (research product, agent, data source, grant).

Research products​

GET /skg-if/v1/products

FilterDescription
product_typeOne of literature, research data, research software, other (the OpenAIRE names publication, dataset, software are also accepted)
identifiers.idIdentifier value, e.g. a DOI
identifiers.schemeIdentifier scheme
contributions.by.local_identifierContributor by local identifier
contributions.by.identifiers.idContributor by identifier value, e.g. an ORCID
contributions.by.identifiers.schemeContributor by identifier scheme
contributions.by.given_nameContributor given name
contributions.by.family_nameContributor family name
contributions.by.nameContributor full name
contributions.declared_affiliations.local_identifierDeclared affiliation by local identifier
contributions.declared_affiliations.identifiers.idDeclared affiliation by identifier value, e.g. a ROR
contributions.declared_affiliations.identifiers.schemeDeclared affiliation by identifier scheme
contributions.declared_affiliations.nameDeclared affiliation name
contributions.declared_affiliations.short_nameDeclared affiliation short name
funding.local_identifierGrant by local identifier
funding.identifiers.idGrant by identifier value
funding.identifiers.schemeGrant by identifier scheme
cf.search.titleFree-text search in the title
cf.search.title_abstractFree-text search in title and abstract
cf.subjectSubject / keyword
cf.languageLanguage, e.g. English
cf.contributions_orcidContributor ORCID
cf.citesProducts citing the given identifier
cf.access_rightsAccess rights of the best manifestation

Organisations​

GET /skg-if/v1/organisations

FilterDescription
identifiers.idIdentifier value, e.g. a ROR
nameOrganisation name
short_nameOrganisation short name or acronym
countryCountry code, e.g. GR
cf.search.nameFree-text search across organisation names

Persons​

GET /skg-if/v1/persons

FilterDescription
identifiers.idIdentifier value, e.g. an ORCID
given_nameGiven name
family_nameFamily name
cf.search.given_nameFree-text search in the given name
cf.search.family_nameFree-text search in the family name
cf.search.nameFree-text search across the full name

Data sources​

GET /skg-if/v1/datasources

FilterDescription
data_source_classificationOne of repository, aggregator, scientific database, journal archive, publisher archive, cris system
identifiers.valueIdentifier value
cf.search.nameFree-text search across the official and English names

Grants​

GET /skg-if/v1/grants

FilterDescription
grant_numberGrant agreement code, e.g. 101017452
acronymGrant acronym
funding_streamFunding stream, matched across all funding levels
funding_agency.short_nameFunder short name, e.g. EC
beneficiaries.nameBeneficiary organisation name
beneficiaries.short_nameBeneficiary organisation short name
beneficiaries.countryBeneficiary organisation country code
cf.search.titleFree-text search in the grant title
cf.duration.start.fromStart date on or after (YYYY or YYYY-MM-DD)
cf.duration.start.toStart date on or before (YYYY or YYYY-MM-DD)
cf.duration.end.fromEnd date on or after (YYYY or YYYY-MM-DD)
cf.duration.end.toEnd date on or before (YYYY or YYYY-MM-DD)

Errors​

CodeWhen
422Unknown filter key for the endpoint, malformed filter syntax, or a value outside the allowed set for product_type, data_source_classification or the grant date filters

A filter that the SKG-IF specification defines but OpenAIRE cannot serve is rejected rather than ignored, so an unsupported filter never silently returns unfiltered results:

{
"message": "key 'identifiers.scheme' is not supported by this endpoint",
"error": "Unprocessable Entity",
"code": 422
}