get_catalog_entry
Read a FamilySearch Catalog entry to inspect holdings, including title, authors, places, notes, films/DGS items, image counts, and view access; also find an entry from a film number.
Instructions
Read a FamilySearch Catalog entry: title, authors, places, notes, and its films.
The Catalog lists the library's holdings. An entry for a county's probate files or deed books lists each film or DGS (digital image group) with a description: volume, case numbers, years. Some run to thousands, so use contains. Each item returned gives its image count and whether this account can view it; open a page with get_film_image(dgs, image).
An entry describes holdings, not a record: cite the image you read. Some films are restricted or were never digitised. A DGS number is not the microfilm number. Given only a film number (as an index citation gives it), finds the entry, so a withheld image can be named and ordered.
Requires an access token.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | Items to return (1-50); each costs a request for its image count. | |
| offset | No | Matching items to skip, for paging. | |
| contains | No | Keep only items whose description holds every word, e.g. 'Box 12' or '#250 1885'. Case is ignored; a number matches whole (250 is not 1250) or inside a span (1885 matches 1880-1890). | |
| catalog_id | No | Catalog number, digits only, e.g. '3154151' from familysearch.org/search/catalog/3154151. | |
| film_number | No | Instead of catalog_id: a DGS or microfilm number. Finds the entry that holds the film and returns only that film's item, which names the volume. |