GET /search/v1/fileauthorities

gov.uk:uk-national-archives-discovery-api

Summary: Search file authorities (record creators)
Operation ID: searchFileAuthorities
Auth: unknown
Description

Execute a search of file authorities including people, organisations, families, businesses and manors.

Parameters (8)

sps.dateFrom (string, query, optional)

Start date (ISO 8601 format)

sps.dateTo (string, query, optional)

End date (ISO 8601 format)

sps.fileAuthorityEntityTypes (array, query, optional)

Record creator type filter. B=Business, D=Diary, F=Family, M=Manor, O=Organisation, P=Person

sps.fileAuthorityGender (array, query, optional)

Gender filter for Person entity type (M=Male, F=Female, O=Other)

sps.page (integer, query, optional)

Page number. Range [0, 100]. page * resultsPerPage must not exceed 10,000

Constraints: {'minimum': 0, 'maximum': 100}

sps.resultsPageSize (integer, query, optional, default: 15)

Search results page size. Range [0, 1000], default 15

Constraints: {'minimum': 0, 'maximum': 1000}

sps.searchQuery (string, query, required)

Search query. May contain boolean expressions (AND, OR, NOT), quotation marks, brackets and wild card (*)

sps.sortByOption (string, query, optional)

Search results sort option

Constraints: {'enum': ['RELEVANCE', 'REFERENCE_ASCENDING', 'DATE_ASCENDING', 'DATE_DESCENDING', 'TITLE_ASCENDING', 'TITLE_DESCENDING']}

No probe data for this endpoint yet.