v1

latestOpenAPI 3.0.02026-08-066425196.1 KB
Contributions

Get search results for contributions data by sending a request with search parameters to the catalog.

Get search results for contributions data by sending a request with search parameters to the catalog. Returns a JSON result.

get/contributions/search

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.

debugboolean

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

searchAfterstring

Enables deep pagination to retrieve records beyond the first 10,000 results. Not compatible with sort, or page parameters.

For the inital request use searchAfter=* and for all subsequent requests set searchAfter to the value of the sort array in the last member of body.hits.hits for each page.

Response

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