Person API
The person API allows you to fetch information about someone by a person identifier or to get a paged list of all people.
Getting a list of people
You can use the person API to retrieve a paged list of all people.
Endpoint
https://gtr.ukri.org/api/person?page=<page-number>&fetchSize=<number-of-items-on-a-page>Where <page-number> is the number of the page you require (which will default to 1 if not provided) and <number-of-items-on-a-page> is the number of items you want to be returned on a page (which defaults to 25 is not provided). See How pagination works for more details on working with paginated results.
HTTP Method
GET
Example
https://gtr.ukri.org/api/person?page=2&fetchSize=25Example results
NOTE: Some items in the various lists included in the results have been truncated to save space.
{
"headerData": {
"lastRefreshDate": "18 Apr 2024"
},
"peopleBean": {
"people": [
{
"id": "056AA010-2EE5-4BD8-8ED4-746585100DF4",
"resourceUrl": "https://gtr.ukri.org/person/056AA010-2EE5-4BD8-8ED4-746585100DF4",
"firstName": "Catherine",
"otherNames": null,
"surname": "Rees",
"email": null,
"orcidId": null,
"displayName": "Rees, Catherine",
"fullName": "Catherine Rees"
},
// ...
{
"id": "032BB448-B895-4A43-9825-6ACFBD336DF0",
"resourceUrl": "https://gtr.ukri.org/person/032BB448-B895-4A43-9825-6ACFBD336DF0",
"firstName": "Christian",
"otherNames": null,
"surname": "Eggeling",
"email": null,
"orcidId": null,
"displayName": "Eggeling, Christian",
"fullName": "Christian Eggeling"
}
]
}
}Getting person by person identifier
To retrieve the details of a person, you need to pass the person's identifier to this endpoint. You can filter the projects associated with the person using the same project search query parameters that you use when searching projects.
Endpoint
https://gtr.ukri.org/api/person/<person-identifier>Where <person-identifier> should be replaced with the identifier for the person you want to retrieve.
HTTP Method
GET
Example
This example will return all projects for the person.
https://gtr.ukri.org/api/person/056AA010-2EE5-4BD8-8ED4-746585100DF4Getting a list of projects containing the term infections.
https://gtr.ukri.org/api/person/056AA010-2EE5-4BD8-8ED4-746585100DF4?term=infectionsExample results
NOTE: Some items in the various lists included in the results have been truncated to save space.
{
"headerData": {
"lastRefreshDate": "18 Apr 2024"
},
"personOverview": {
"person": {
"id": "056AA010-2EE5-4BD8-8ED4-746585100DF4",
"resourceUrl": "https://gtr.ukri.org/person/056AA010-2EE5-4BD8-8ED4-746585100DF4",
"firstName": "Catherine",
"otherNames": null,
"surname": "Rees",
"email": null,
"orcidId": null,
"displayName": "Rees, Catherine",
"fullName": "Catherine Rees"
},
"projectSearchResult": {
"request": {
"page": 1,
"fetchSize": 25,
"selectedSortableField": "",
"selectedSortOrder": "",
"term": null,
"fields": "",
"selectedFacets": "",
"type": "",
"detailedAndFilter": false,
"termEncoded": null
},
"totalResults": 3,
"didYouMean": [],
"results": [
{
"projectComposition": {
"project": {
"id": "515582B5-4F75-4819-916E-960567B73806",
"resourceUrl": "https://gtr.ukri.org/projects?ref=studentship-2432078",
"title": "Understanding Phage-Host Interactions to Improve Rapid Diagnosis of Early TB Infections in Humans",
"status": null,
"grantReference": "2432078",
"grantCategory": "Studentship",
"abstractText": null,
"potentialImpactText": null,
"fund": {
"valuePounds": 0,
"start": 1601506800000,
"end": 1727650800000,
"funder": {
"id": "2512EF1C-401B-4222-9869-A770D4C5FAC7",
"resourceUrl": "https://gtr.ukri.org/organisation/2512EF1C-401B-4222-9869-A770D4C5FAC7",
"name": "BBSRC"
},
"type": "INCOME_ACTUAL"
},
"output": null,
"publications": null,
"identifiers": null,
"technicalSummary": null,
"projectHierarchy": null,
"studentshipHierarchy": null,
"healthCategories": [],
"researchActivities": [],
"researchSubjects": [],
"researchTopics": [],
"rcukProgrammes": [],
"hasClassifications": false
},
"leadResearchOrganisation": {
"id": "411FC677-E420-46F2-B7A2-346ECED37574",
"resourceUrl": "https://gtr.ukri.org/organisation/411FC677-E420-46F2-B7A2-346ECED37574",
"name": "University of Nottingham",
"website": null,
"address": null,
"department": null,
"typeInd": null,
"federatedIds": null
},
"personRoles": [],
"collaborations": null,
"organisationRoles": null,
"principalInvestigators": [],
"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": 2
},
{
"id": "c3RhdHVzfEFjdGl2ZXxzdHJpbmc=",
"applied": false,
"name": "Active",
"count": 1
}
],
"sortOrder": "A"
},
{
"name": "Funded Amount",
"facets": [
{
"id": "YW1vdW50fC05MjIzMzcyMDM2ODU0Nzc1ODA4XzEwMDAwMHxyYW5nZQ==",
"applied": false,
"name": "Up to £100K",
"count": 2
},
// ...
{
"id": "YW1vdW50fDEwMDAwMDAwXzkyMjMzNzIwMzY4NTQ3NzU4MDd8cmFuZ2U=",
"applied": false,
"name": "Above £10M",
"count": 0
}
],
"sortOrder": "N"
},
{
"name": "Region",
"facets": [
{
"id": "cmVnaW9ufEVhc3QgTWlkbGFuZHN8c3RyaW5n",
"applied": false,
"name": "East Midlands",
"count": 3
},
// ...
{
"id": "cmVnaW9ufE5vcnRoZXJuIElyZWxhbmR8c3RyaW5n",
"applied": false,
"name": "Northern Ireland",
"count": 0
}
],
"sortOrder": "A"
},
{
"name": "Project Category",
"facets": [
{
"id": "Y2F0fFN0dWRlbnRzaGlwfHN0cmluZw==",
"applied": false,
"name": "Studentship",
"count": 2
},
// ...
{
"id": "Y2F0fExhcmdlIFByb2plY3R8c3RyaW5n",
"applied": false,
"name": "Large Project",
"count": 0
}
],
"sortOrder": "A"
},
{
"name": "Funder",
"facets": [
{
"id": "ZnVuZGVyfEJCU1JDfHN0cmluZw==",
"applied": false,
"name": "BBSRC",
"count": 2
},
// ...
{
"id": "ZnVuZGVyfEF5cnRvbiBGdW5kfHN0cmluZw==",
"applied": false,
"name": "AYRTON FUND",
"count": 0
}
],
"sortOrder": "A"
},
{
"name": "Start Year",
"facets": [
{
"id": "c3RhcnR8MTU3NzgzNjgwMDAwMF8xNjA5NDU5MTk5MDU5fHJhbmdl",
"applied": false,
"name": "2020",
"count": 1
},
// ...
{
"id": "c3RhcnR8MTYwOTQ1OTIwMDAwMF8xNjQwOTk1MTk5MDU5fHJhbmdl",
"applied": false,
"name": "2021",
"count": 0
}
],
"sortOrder": "D"
}
],
"resourceHitCounts": [
{
"resource": "project",
"count": 3
}
],
"selectedFacets": "",
"appliedSearchFields": "",
"appliedSortField": "pro.sd",
"appliedSortOrder": "DESC",
"csvEndpoint": "056AA010-2EE5-4BD8-8ED4-746585100DF4/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,
"page": 1,
"fetchSize": 25,
"paramsWithoutSortOrder": "term=&selectedFacets=&fields=&type=&fetchSize=25&page=1&selectedSortableField=pro.sd",
"paramsWithoutSortOrderOrSortField": "term=&selectedFacets=&fields=&type=&fetchSize=25&page=1",
"paramsWithoutPage": "term=&selectedFacets=&fields=&type=&fetchSize=25&selectedSortableField=pro.sd&selectedSortOrder=DESC",
"paramsWithoutFetchSize": "term=&selectedFacets=&fields=&type=&page=1&selectedSortableField=pro.sd&selectedSortOrder=DESC",
"totalPages": 1,
"paginationStart": 1,
"paginationEnd": 1
},
"organisation": {
"id": "411FC677-E420-46F2-B7A2-346ECED37574",
"resourceUrl": "https://gtr.ukri.org/organisation/411FC677-E420-46F2-B7A2-346ECED37574",
"name": "University of Nottingham",
"website": null,
"address": null,
"department": null,
"typeInd": null,
"federatedIds": null
}
}
}