Searching organisations

The search organisation API endpoint searches all organisations for a specific term.

Endpoint

https://gtr.ukri.org/api/search/organisation?term=<term>

HTTP method

GET

Request parameters

Search API query parameters provides information about the request parameters.

Example

https://gtr.ukri.org/api/search/organisation?term=mouse&page=1&fetchSize=25&selectedSortableField=&selectedSortOrder=&fields=org.pro.abs

Example 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": 1,
            "fetchSize": 25,
            "selectedSortableField": "",
            "selectedSortOrder": "",
            "term": "mouse",
            "fields": "org.pro.abs",
            "selectedFacets": "",
            "type": "",
            "detailedAndFilter": false,
            "termEncoded": "mouse"
        },
        "totalResults": 1523,
        "didYouMean": [],
        "results": [
            {
                "organisation": {
                    "id": "CCEDA048-0AA8-4144-A243-FFF2F147B4AA",
                    "resourceUrl": "https://gtr.ukri.org/organisation/CCEDA048-0AA8-4144-A243-FFF2F147B4AA",
                    "name": "Mouse Clinical Institute",
                    "website": null,
                    "address": null,
                    "department": null,
                    "typeInd": null,
                    "federatedIds": null
                },
                "projectSearchResult": null
            },
            // ...
            {
                "organisation": {
                    "id": "3F3733A0-49D5-4DF0-87BE-F85B6A354B9D",
                    "resourceUrl": "https://gtr.ukri.org/organisation/3F3733A0-49D5-4DF0-87BE-F85B6A354B9D",
                    "name": "Invicro (United States)",
                    "website": null,
                    "address": null,
                    "department": null,
                    "typeInd": null,
                    "federatedIds": null
                },
                "projectSearchResult": null
            }
        ],
        "sortableFields": [
            {
                "fieldName": "org.n",
                "displayName": "Organisation Name"
            },
            {
                "fieldName": "score",
                "displayName": "Relevance"
            }
        ],
        "facetGroups": [
            {
                "name": "Region",
                "facets": [
                    {
                        "id": "cmVnaW9ufFVua25vd258c3RyaW5n",
                        "applied": false,
                        "name": "Unknown",
                        "count": 466
                    },
                    // ...
                    {
                        "id": "cmVnaW9ufE5vcnRoZXJuIElyZWxhbmR8c3RyaW5n",
                        "applied": false,
                        "name": "Northern Ireland",
                        "count": 4
                    }
                ],
                "sortOrder": "A"
            }
        ],
        "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": "organisation/csv",
        "searchableFields": [
            {
                "fieldName": "org.orcidId",
                "displayName": "ORCID iD"
            },
            {
                "fieldName": "org.n",
                "displayName": "Organisation Name"
            },
            {
                "fieldName": "org.pro.a",
                "displayName": "Project Abstracts"
            },
            {
                "fieldName": "org.pro.t",
                "displayName": "Project Titles"
            }
        ],
        "downloadable": true,
        "childFacetGroups": null,
        "parentChildMap": null,
        "indexType": null,
        "numberOfSearchFieldDisplayColumns": 2,
        "page": 1,
        "fetchSize": 25,
        "paramsWithoutSortOrder": "term=mouse&selectedFacets=&fields=&type=&fetchSize=25&page=1&selectedSortableField=score",
        "paramsWithoutSortOrderOrSortField": "term=mouse&selectedFacets=&fields=&type=&fetchSize=25&page=1",
        "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": 61,
        "paginationStart": 1,
        "paginationEnd": 5
    }
}