Searching projects
The search project API endpoint searches all projects for a specific term.
Endpoint
https://gtr.ukri.org/api/search/project?term=<term>HTTP method
GET
Request parameters
Search API query parameters provides information about the request parameters.
Example
https://gtr.ukri.org/api/search/project?term=mouse&page=2&fetchSize=25&selectedSortableField=score&selectedSortOrder=DESC&selectedFacets=&fields=project.absExample results
NOTE: Some items in the various lists included in the results below have been truncated to save space.
{
"headerData": {
"lastRefreshDate": "18 Apr 2024"
},
"facetedSearchResultBean": {
"request": {
"page": 2,
"fetchSize": 25,
"selectedSortableField": "score",
"selectedSortOrder": "DESC",
"term": "mouse",
"fields": "project.abs",
"selectedFacets": "",
"type": "",
"detailedAndFilter": false,
"termEncoded": "mouse"
},
"totalResults": 3973,
"didYouMean": [],
"results": [
{
"projectComposition": {
"project": {
"id": "D8217775-25AE-4913-AC61-4402249C330E",
"resourceUrl": "https://gtr.ukri.org/projects?ref=MC_UU_00007%2F8",
"title": "Composition of a regulatory locus and the impact on phenotype and disease",
"status": null,
"grantReference": "MC_UU_00007/8",
"grantCategory": "Intramural",
"abstractText": null,
"potentialImpactText": null,
"fund": {
"valuePounds": 4072000,
"start": 1522537200000,
"end": 1672444800000,
"funder": {
"id": "C008C651-F5B0-4859-A334-5F574AB6B57C",
"resourceUrl": "https://gtr.ukri.org/organisation/C008C651-F5B0-4859-A334-5F574AB6B57C",
"name": "MRC"
},
"type": "EXPENDITURE_ACTUAL"
},
"output": null,
"publications": null,
"identifiers": null,
"technicalSummary": null,
"projectHierarchy": null,
"studentshipHierarchy": null,
"healthCategories": [],
"researchActivities": [],
"researchSubjects": [],
"researchTopics": [],
"rcukProgrammes": [],
"hasClassifications": false
},
"leadResearchOrganisation": {
"id": "A4735E0B-ED6E-4FC5-9497-CFE564317F54",
"resourceUrl": "https://gtr.ukri.org/organisation/A4735E0B-ED6E-4FC5-9497-CFE564317F54",
"name": "University of Edinburgh",
"website": null,
"address": null,
"department": null,
"typeInd": null,
"federatedIds": null
},
"personRoles": [
{
"id": "E72B16DA-ADA5-4AC5-93EE-508F88E911EB",
"resourceUrl": "https://gtr.ukri.org/person/E72B16DA-ADA5-4AC5-93EE-508F88E911EB",
"firstName": "Robert",
"otherNames": null,
"surname": "Hill",
"email": null,
"orcidId": null,
"roles": [
{
"name": "PRINCIPAL_INVESTIGATOR",
"start": null,
"end": null
}
],
"principalInvestigator": true,
"coInvestigator": false,
"fellow": false,
"projectManager": false,
"researcher": false,
"researcherCOI": false,
"trainingGrantHolder": false,
"supervisor": false,
"student": false,
"displayName": "Hill, Robert",
"fullName": "Robert Hill"
}
],
"collaborations": null,
"organisationRoles": null,
"principalInvestigators": [
{
"id": "E72B16DA-ADA5-4AC5-93EE-508F88E911EB",
"resourceUrl": "https://gtr.ukri.org/person/E72B16DA-ADA5-4AC5-93EE-508F88E911EB",
"firstName": "Robert",
"otherNames": null,
"surname": "Hill",
"email": null,
"orcidId": null,
"roles": [
{
"name": "PRINCIPAL_INVESTIGATOR",
"start": null,
"end": null
}
],
"principalInvestigator": true,
"coInvestigator": false,
"fellow": false,
"projectManager": false,
"researcher": false,
"researcherCOI": false,
"trainingGrantHolder": false,
"supervisor": false,
"student": false,
"displayName": "Hill, Robert",
"fullName": "Robert Hill"
}
],
"coInvestigators": [],
"fellows": [],
"projectManagers": [],
"researchers": [],
"researcherCOIs": [],
"supervisors": [],
"students": [],
"trainingGrantHolders": []
},
"abstractSnippet": null
},
// ...
],
"sortableFields": [
{
"fieldName": "pro.sd",
"displayName": "Start Date"
},
{
"fieldName": "pro.ed",
"displayName": "End Date"
},
{
"fieldName": "pro.am",
"displayName": "Funded Value"
},
{
"fieldName": "score",
"displayName": "Relevance"
}
],
"facetGroups": [
{
"name": "Project Status",
"facets": [
{
"id": "c3RhdHVzfENsb3NlZHxzdHJpbmc=",
"applied": false,
"name": "Closed",
"count": 3213
},
{
"id": "c3RhdHVzfEFjdGl2ZXxzdHJpbmc=",
"applied": false,
"name": "Active",
"count": 757
}
],
"sortOrder": "A"
},
{
"name": "Funded Amount",
"facets": [
{
"id": "YW1vdW50fC05MjIzMzcyMDM2ODU0Nzc1ODA4XzEwMDAwMHxyYW5nZQ==",
"applied": false,
"name": "Up to £100K",
"count": 830
},
{
"id": "YW1vdW50fDEwMDAwMF8xMDAwMDAwfHJhbmdl",
"applied": false,
"name": "£100K to £1M",
"count": 2565
},
{
"id": "YW1vdW50fDEwMDAwMDBfMTAwMDAwMDB8cmFuZ2U=",
"applied": false,
"name": "£1M to £10M",
"count": 566
},
{
"id": "YW1vdW50fDEwMDAwMDAwXzkyMjMzNzIwMzY4NTQ3NzU4MDd8cmFuZ2U=",
"applied": false,
"name": "Above £10M",
"count": 12
}
],
"sortOrder": "N"
},
{
"name": "Region",
"facets": [
{
"id": "cmVnaW9ufExvbmRvbnxzdHJpbmc=",
"applied": false,
"name": "London",
"count": 1034
},
// ...
{
"id": "cmVnaW9ufE5vcnRoZXJuIElyZWxhbmR8c3RyaW5n",
"applied": false,
"name": "Northern Ireland",
"count": 34
}
],
"sortOrder": "A"
},
{
"name": "Project Category",
"facets": [
{
"id": "Y2F0fFJlc2VhcmNoIEdyYW50fHN0cmluZw==",
"applied": false,
"name": "Research Grant",
"count": 2731
},
// ...
{
"id": "Y2F0fExhcmdlIFByb2plY3R8c3RyaW5n",
"applied": false,
"name": "Large Project",
"count": 0
}
],
"sortOrder": "A"
},
{
"name": "Funder",
"facets": [
{
"id": "ZnVuZGVyfE1SQ3xzdHJpbmc=",
"applied": false,
"name": "MRC",
"count": 1958
},
// ...
{
"id": "ZnVuZGVyfEF5cnRvbiBGdW5kfHN0cmluZw==",
"applied": false,
"name": "AYRTON FUND",
"count": 0
}
],
"sortOrder": "A"
},
{
"name": "Start Year",
"facets": [
{
"id": "c3RhcnR8MTc5ODc2MTYwMDAwMF8xODMwMjk3NTk5MDU5fHJhbmdl",
"applied": false,
"name": "2027",
"count": 1
},
// ...
{
"id": "c3RhcnR8MTE5OTE0NTYwMDAwMF8xMjMwNzY3OTk5MDU5fHJhbmdl",
"applied": false,
"name": "2008",
"count": 153
}
],
"sortOrder": "D"
}
],
"resourceHitCounts": [
{
"resource": "publication",
"count": 4210
},
{
"resource": "outcomes",
"count": 3260
},
{
"resource": "project",
"count": 3973
},
{
"resource": "people",
"count": 3338
},
{
"resource": "organisation",
"count": 1523
},
{
"resource": "classificationproject",
"count": 3097
}
],
"selectedFacets": "",
"appliedSearchFields": "",
"appliedSortField": "score",
"appliedSortOrder": "DESC",
"csvEndpoint": "project/csv",
"searchableFields": [
{
"fieldName": "pro.orcidId",
"displayName": "ORCID iD"
},
{
"fieldName": "pro.a",
"displayName": "Project Abstract"
},
{
"fieldName": "pro.gr",
"displayName": "Project Reference"
},
{
"fieldName": "pro.t",
"displayName": "Project Title"
}
],
"downloadable": true,
"childFacetGroups": null,
"parentChildMap": null,
"indexType": null,
"numberOfSearchFieldDisplayColumns": 2,
"page": 2,
"fetchSize": 25,
"paramsWithoutSortOrder": "term=mouse&selectedFacets=&fields=&type=&fetchSize=25&page=2&selectedSortableField=score",
"paramsWithoutSortOrderOrSortField": "term=mouse&selectedFacets=&fields=&type=&fetchSize=25&page=2",
"paramsWithoutPage": "term=mouse&selectedFacets=&fields=&type=&fetchSize=25&selectedSortableField=score&selectedSortOrder=DESC",
"paramsWithoutFetchSize": "term=mouse&selectedFacets=&fields=&type=&page=1&selectedSortableField=score&selectedSortOrder=DESC",
"totalPages": 159,
"paginationStart": 1,
"paginationEnd": 5
}
}