v1

latestOpenAPI 3.0.02026-08-066425196.1 KB
Records

Get records related to transcriptions by using url parameters to perform a catalog search.

Get records related to transcriptions by using url parameters to perform a catalog search. Returns a JSON result.

get/records/search/by-transcription

Query parameters

qstring

A search query string which accepts boolean operators (AND, OR, NOT), wildcards (*), and exact phrases ("").

idstring

An individual contribution's unique identifier which maps to the record.contributionId field

userNamestring

Contributor's screen name which maps to the record.contributor.userName field

userIdstring

Contributor's unique identifier which maps to the record.contributor.userId field

naIdstring

An array of NARA-specific identifiers, each of which is unique to a single record.

pageinteger

Page number of the paginated result set in which to return.

limitinteger

Maximum number of results returned for each page of paginated data.

debugboolean

Turns on debug mode, showing metadata in the response body, if set to true.

abbreviatedboolean

Abbreviated results flag, which when true, returns a shorter version of the results.

Response

A body of response data containing full record objects if any were found.