Searching people

The search person API endpoint searches all people for a specific term.

Endpoint

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

HTTP method

GET

Request parameters

Search API query parameters provides information about the request parameters.

Example

https://gtr.ukri.org/api/search/person?term=mouse&page=2&fetchSize=25&selectedSortableField=per.sn&selectedSortOrder=DESC&selectedFacets=&fields=per.on,per.fn,per.sn,per.org.n,per.pro.abs,per.pro.t

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": 2,
            "fetchSize": 25,
            "selectedSortableField": "per.sn",
            "selectedSortOrder": "DESC",
            "term": "mouse",
            "fields": "per.on,per.fn,per.sn,per.org.n,per.pro.abs,per.pro.t",
            "selectedFacets": "",
            "type": "",
            "detailedAndFilter": false,
            "termEncoded": "mouse"
        },
        "totalResults": 3338,
        "didYouMean": [],
        "results": [
            {
                "person": {
                    "id": "00CF0561-DCB5-4532-83DA-FB6D753743D2",
                    "resourceUrl": "https://gtr.ukri.org/person/00CF0561-DCB5-4532-83DA-FB6D753743D2",
                    "firstName": "Paola",
                    "otherNames": null,
                    "surname": "Zaccone",
                    "email": null,
                    "orcidId": null,
                    "displayName": "Zaccone, Paola",
                    "fullName": "Paola Zaccone"
                },
                "projectSearchResult": null,
                "organisation": {
                    "id": "8C59383D-467C-4A3E-AF65-4B3F82FD1E27",
                    "resourceUrl": "https://gtr.ukri.org/organisation/8C59383D-467C-4A3E-AF65-4B3F82FD1E27",
                    "name": "University of Cambridge",
                    "website": null,
                    "address": null,
                    "department": null,
                    "typeInd": null,
                    "federatedIds": null
                }
            },
            // ...
            {
                "person": {
                    "id": "4612EB81-01D4-48E8-9F77-C85B953F2435",
                    "resourceUrl": "https://gtr.ukri.org/person/4612EB81-01D4-48E8-9F77-C85B953F2435",
                    "firstName": "Saroshi",
                    "otherNames": null,
                    "surname": "Yamazaki",
                    "email": null,
                    "orcidId": null,
                    "displayName": "Yamazaki, Saroshi",
                    "fullName": "Saroshi Yamazaki"
                },
                "projectSearchResult": null,
                "organisation": {
                    "id": "B861C691-46C8-4677-8D89-75575418E0D9",
                    "resourceUrl": "https://gtr.ukri.org/organisation/B861C691-46C8-4677-8D89-75575418E0D9",
                    "name": "University of Tokyo",
                    "website": null,
                    "address": null,
                    "department": null,
                    "typeInd": null,
                    "federatedIds": null
                }
            }
        ],
        "sortableFields": [
            {
                "fieldName": "per.fn",
                "displayName": "First Name"
            },
            {
                "fieldName": "per.sn",
                "displayName": "Family Name"
            },
            {
                "fieldName": "score",
                "displayName": "Relevance"
            }
        ],
        "facetGroups": [
            {
                "name": "Family Name",
                "facets": [
                    {
                        "id": "c3VybmFtZXx3aWxsaWFtc3xzdHJpbmc=",
                        "applied": false,
                        "name": "williams",
                        "count": 18
                    },
                    // ...
                    {
                        "id": "c3VybmFtZXxtdXJyYXl8c3RyaW5n",
                        "applied": false,
                        "name": "murray",
                        "count": 6
                    }
                ],
                "sortOrder": "A"
            },
            {
                "name": "First Name",
                "facets": [
                    {
                        "id": "Zmlyc3ROYW1lfGRhdmlkfHN0cmluZw==",
                        "applied": false,
                        "name": "david",
                        "count": 89
                    },
                    // ...
                    {
                        "id": "Zmlyc3ROYW1lfGtldmlufHN0cmluZw==",
                        "applied": false,
                        "name": "kevin",
                        "count": 15
                    }
                ],
                "sortOrder": "A"
            }
        ],
        "resourceHitCounts": [
            {
                "resource": "people",
                "count": 3338
            }
        ],
        "selectedFacets": "",
        "appliedSearchFields": "per.on,per.fn,per.pro.abs,per.org.n,per.sn,per.pro.t",
        "appliedSortField": "per.sn",
        "appliedSortOrder": "DESC",
        "csvEndpoint": "person/csv",
        "searchableFields": [
            {
                "fieldName": "per.sn",
                "displayName": "Family Name"
            },
            {
                "fieldName": "per.fn",
                "displayName": "First Name"
            },
            {
                "fieldName": "per.fnsn",
                "displayName": "First Name Family Name"
            },
            {
                "fieldName": "per.orcidId",
                "displayName": "ORCID iD"
            },
            {
                "fieldName": "per.org.n",
                "displayName": "Organisation Name"
            },
            {
                "fieldName": "per.on",
                "displayName": "Other Names"
            },
            {
                "fieldName": "per.pro.abs",
                "displayName": "Project Abstracts"
            },
            {
                "fieldName": "per.pro.t",
                "displayName": "Project Titles"
            }
        ],
        "downloadable": true,
        "childFacetGroups": null,
        "parentChildMap": null,
        "indexType": null,
        "numberOfSearchFieldDisplayColumns": 3,
        "page": 2,
        "fetchSize": 25,
        "paramsWithoutSortOrder": "term=mouse&selectedFacets=&fields=per.on,per.fn,per.pro.abs,per.org.n,per.sn,per.pro.t&type=&fetchSize=25&page=2&selectedSortableField=per.sn",
        "paramsWithoutSortOrderOrSortField": "term=mouse&selectedFacets=&fields=per.on,per.fn,per.pro.abs,per.org.n,per.sn,per.pro.t&type=&fetchSize=25&page=2",
        "paramsWithoutPage": "term=mouse&selectedFacets=&fields=per.on,per.fn,per.pro.abs,per.org.n,per.sn,per.pro.t&type=&fetchSize=25&selectedSortableField=per.sn&selectedSortOrder=DESC",
        "paramsWithoutFetchSize": "term=mouse&selectedFacets=&fields=per.on,per.fn,per.pro.abs,per.org.n,per.sn,per.pro.t&type=&page=1&selectedSortableField=per.sn&selectedSortOrder=DESC",
        "totalPages": 134,
        "paginationStart": 1,
        "paginationEnd": 5
    }                   
}