Organisation API
The organisation API allows you to fetch information about an organisation by organisation identifier or to get a paged list of all organisations.
Getting a list of organisations
You can use the organisation API to retrieve a paged list of all organisations.
Endpoint
https://gtr.ukri.org/api/organisation?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/organisation?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"
},
"organisationsBean": {
"organisations": [
{
"id": "9652E649-8274-44AC-96EC-EA0531CFBA52",
"resourceUrl": "http://gtr.ukri.org/organisation/9652E649-8274-44AC-96EC-EA0531CFBA52",
"name": "GCRF",
"website": null,
"address": null,
"department": null,
"typeInd": null,
"federatedIds": null
},
{
"id": "4F92ABFC-7177-4893-9F8F-1A52D88F35F6",
"resourceUrl": "http://gtr.ukri.org/organisation/4F92ABFC-7177-4893-9F8F-1A52D88F35F6",
"name": "REPKNIGHT LIMITED",
"website": null,
"address": {
"line1": null,
"line2": null,
"line3": null,
"line4": null,
"city": null,
"line5": null,
"county": null,
"postCode": "BT12 5GH",
"region": "Northern Ireland",
"country": null,
"addressLine": "BT12 5GH (Northern Ireland)"
},
"department": null,
"typeInd": null,
"federatedIds": null
},
// ...
]
}
}Getting organisation by organisation identifier
To retrieve the details of an organisation, you need to pass the organisation's identifier to this endpoint. You can filter the projects associated with the organisation using the same project search query parameters that you use when searching projects.
Endpoint
https://gtr.ukri.org/api/organisation/<organisation-identifier>Where <organisation-identifier> should be replaced with the identifier for the organisation you want to retrieve.
HTTP Method
GET
Example
This example will return all projects for the organisation.
https://gtr.ukri.org/api/organisation/4F92ABFC-7177-4893-9F8F-1A52D88F35F6Getting a list of organisations containing the term longitudinal.
https://gtr.ukri.org/api/organisation/4F92ABFC-7177-4893-9F8F-1A52D88F35F6?term=longitudinalExample results
NOTE: Some items in the various lists included in the results have been truncated to save space.
{
"headerData": {
"lastRefreshDate": "18 Apr 2024"
},
"organisationOverview": {
"organisation": {
"id": "748BB951-8793-4857-ABC1-28F82D48935B",
"resourceUrl": "http://gtr.ukri.org/organisation/748BB951-8793-4857-ABC1-28F82D48935B",
"name": "Cambridge Cognition Ltd",
"website": null,
"address": null,
"department": null,
"typeInd": null,
"federatedIds": null
},
"projectSearchResult": {
"request": {
"page": 1,
"fetchSize": 25,
"selectedSortableField": "",
"selectedSortOrder": "",
"term": null,
"fields": "",
"selectedFacets": "",
"type": "",
"detailedAndFilter": false,
"termEncoded": null
},
"totalResults": 6,
"didYouMean": [],
"results": [
{
"projectComposition": {
"project": {
"id": "C56B0125-0A19-4655-A241-11FB9E677C4F",
"resourceUrl": "http://gtr.ukri.org/projects?ref=MC_PC_17207",
"title": "Scaling up translational research through the Confidence in Concept (CiC) scheme",
"status": null,
"grantReference": "MC_PC_17207",
"grantCategory": "Intramural",
"abstractText": null,
"potentialImpactText": null,
"fund": {
"valuePounds": 590000,
"start": 1519862400000,
"end": 1625007600000,
"funder": {
"id": "5807F429-7BF0-4E42-917E-D4ADF5399E7B",
"resourceUrl": "http://gtr.ukri.org/organisation/5807F429-7BF0-4E42-917E-D4ADF5399E7B",
"name": "UKRI"
},
"type": "EXPENDITURE_ACTUAL"
},
"output": null,
"publications": null,
"identifiers": null,
"technicalSummary": null,
"projectHierarchy": null,
"studentshipHierarchy": null,
"healthCategories": [],
"researchActivities": [],
"researchSubjects": [],
"researchTopics": [],
"rcukProgrammes": [],
"hasClassifications": false
},
"leadResearchOrganisation": {
"id": "25335D80-2025-4154-989F-37646A6EFBE1",
"resourceUrl": "http://gtr.ukri.org/organisation/25335D80-2025-4154-989F-37646A6EFBE1",
"name": "University of Bristol",
"website": null,
"address": null,
"department": null,
"typeInd": null,
"federatedIds": null
},
"personRoles": [
{
"id": "6DD488E4-1F94-4B98-9767-24890566FFB5",
"resourceUrl": "http://gtr.ukri.org/person/6DD488E4-1F94-4B98-9767-24890566FFB5",
"firstName": "Jeremy",
"otherNames": null,
"surname": "Tavare",
"email": null,
"orcidId": null,
"roles": [
{
"name": "PRINCIPAL_INVESTIGATOR",
"start": null,
"end": null
}
],
"projectManager": false,
"researcher": false,
"researcherCOI": false,
"trainingGrantHolder": false,
"supervisor": false,
"student": false,
"principalInvestigator": true,
"coInvestigator": false,
"fellow": false,
"displayName": "Tavare, Jeremy",
"fullName": "Jeremy Tavare"
}
],
"collaborations": null,
"organisationRoles": null,
"principalInvestigators": [
{
"id": "6DD488E4-1F94-4B98-9767-24890566FFB5",
"resourceUrl": "http://gtr.ukri.org/person/6DD488E4-1F94-4B98-9767-24890566FFB5",
"firstName": "Jeremy",
"otherNames": null,
"surname": "Tavare",
"email": null,
"orcidId": null,
"roles": [
{
"name": "PRINCIPAL_INVESTIGATOR",
"start": null,
"end": null
}
],
"projectManager": false,
"researcher": false,
"researcherCOI": false,
"trainingGrantHolder": false,
"supervisor": false,
"student": false,
"principalInvestigator": true,
"coInvestigator": false,
"fellow": false,
"displayName": "Tavare, Jeremy",
"fullName": "Jeremy Tavare"
}
],
"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": 6
},
{
"id": "c3RhdHVzfEFjdGl2ZXxzdHJpbmc=",
"applied": false,
"name": "Active",
"count": 0
}
],
"sortOrder": "A"
},
{
"name": "Funded Amount",
"facets": [
{
"id": "YW1vdW50fC05MjIzMzcyMDM2ODU0Nzc1ODA4XzEwMDAwMHxyYW5nZQ==",
"applied": false,
"name": "Up to £100K",
"count": 0
},
// ...
],
"sortOrder": "N"
},
{
"name": "Region",
"facets": [
{
"id": "cmVnaW9ufExvbmRvbnxzdHJpbmc=",
"applied": false,
"name": "London",
"count": 2
},
// ...
{
"id": "cmVnaW9ufE5vcnRoZXJuIElyZWxhbmR8c3RyaW5n",
"applied": false,
"name": "Northern Ireland",
"count": 0
}
],
"sortOrder": "A"
},
{
"name": "Project Category",
"facets": [
{
"id": "Y2F0fEludHJhbXVyYWx8c3RyaW5n",
"applied": false,
"name": "Intramural",
"count": 3
},
// ...
{
"id": "Y2F0fExhcmdlIFByb2plY3R8c3RyaW5n",
"applied": false,
"name": "Large Project",
"count": 0
}
],
"sortOrder": "A"
},
{
"name": "Funder",
"facets": [
{
"id": "ZnVuZGVyfE1SQ3xzdHJpbmc=",
"applied": false,
"name": "MRC",
"count": 4
},
// ...
{
"id": "ZnVuZGVyfEF5cnRvbiBGdW5kfHN0cmluZw==",
"applied": false,
"name": "AYRTON FUND",
"count": 0
}
],
"sortOrder": "A"
},
{
"name": "Start Year",
"facets": [
{
"id": "c3RhcnR8MTUxNDc2NDgwMDAwMF8xNTQ2MzAwNzk5MDU5fHJhbmdl",
"applied": false,
"name": "2018",
"count": 1
},
// ...
{
"id": "c3RhcnR8MTIzMDc2ODAwMDAwMF8xMjYyMzAzOTk5MDU5fHJhbmdl",
"applied": false,
"name": "2009",
"count": 0
}
],
"sortOrder": "D"
}
],
"resourceHitCounts": [
{
"resource": "project",
"count": 6
}
],
"selectedFacets": "",
"appliedSearchFields": "",
"appliedSortField": "pro.sd",
"appliedSortOrder": "DESC",
"csvEndpoint": "748BB951-8793-4857-ABC1-28F82D48935B/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
}
}
}