---
title: "Retrieve information about metadata records in the SDC database."
method: GET
path: "/datacatalog/api/harvest/files"
tags: ["Harvest"]
---

# Retrieve information about metadata records in the SDC database.

`GET /datacatalog/api/harvest/files`

## Request

- Base URL: `https://data.usgs.gov` (the document declares no server; this is the origin it was published from)
- URL: `https://data.usgs.gov/datacatalog/api/harvest/files`
- Auth: none declared

Retrieve information such as harvest dates, record validation,
data source, title, etc. for metadata records in the SDC database
using the parameters below.

**Parameters**
* `pid`: Persistent identifier for the metadata record in the format USGS:xxxxxxx, e.g., USGS:5a0b1033e4b09af898cb6e7a
* `doi`: Digital object identifier in the format of a valid URL, e.g., https://doi.org/10.5066/P9ZRJ3XU
* `title`: Title provided in the metadata record
* `author`: Authors of the data listed in the metadata record
* `data_source_name`: Name of the USGS science center or program that is responsible for creating and maintaining the metadata and data.
* `harvest_source_name`: Name of the repository that is providing the metadata records to the SDC. See a complete list below under HarvestSourceEnum schema.
* `page`: Page number of the results set. Default is the first page represented by 1.
* `size`: Number of results to return per request. Default is 10.
* `sort_by`: Field to sort the results by. Options are:
   * `pid` (default)
   * `title`
   * `harvest_date`
   * `modified_date`
   * `status`: Date that a file was last indexed; this will be `null` if the file has not been indexed
   * `harvest_source_name`
   * `data_source_name`
* `sort_desc`: Sort results in descending order by field specified in `sort_by`; true/false

## Query parameters

- `sort_desc` boolean, nullable
- `pid` string, nullable
- `doi` string, nullable
- `title` string, nullable
- `author` string, nullable
- `data_source_name` string, nullable
- `harvest_source_name` string, nullable
- `page` integer
- `size` integer
- `sort_by` string

## Response `200`

Successful Response

- PageHarvestedFileExtended
  - `items` HarvestedFileExtended[], required
    - `id` string, required
    - `date_first_harvested` string, date-time, required
    - `date_effective` string, date-time, required
    - `date_last_harvested` string, date-time, required
    - `date_modified` string, date-time, nullable
    - `date_indexed` string, date-time, nullable
    - `data_source_id` integer, nullable
    - `data_source_name` string, nullable
    - `file_url` string, required
    - `file_removed` boolean, required
    - `filename` string, required
    - `record_checks` RecordChecks, required
      - `xml_valid` boolean, required
      - `doi_present` boolean, required
      - `pid_in_file` boolean, required
      - `mdate_present` boolean, required
      - `pid_in_pir_db` boolean, required
      - `title_present` boolean, required
      - `email_contact_present` boolean, required
    - `metadata_cntemail` string, nullable
    - `metadata_doi` string, nullable
    - `metadata_mdate` string, nullable
    - `metadata_pid` string, nullable
    - `metadata_title` string, nullable
    - `pid_url` string, nullable
    - `authors` Author[], nullable
      - `author_name` string, required
      - `name_type` 'Personal' | 'USGSPersonal' | 'Organizational', required
      - `orcid` string, nullable
    - `repository` Repository
      - `id` integer, required
      - `name` 'Alaska Science Center' | 'Coastal and Marine Geoscience Data System' | 'Earth Resources Observation and Science Center' | 'Geoscience Data Catalog' | 'Individual Metadata Uploader' | 'National Uranium Resource Evaluation' | 'ScienceBase' | 'SDC Metadata Bridge' | 'Water NSDI Node', required
      - `short_name` string, required
      - `type` string, required
      - `url` string, uri, required
  - `total` integer, required
  - `page` integer, required
  - `size` integer, required
  - `pages` integer, required

## Other responses

- `404`: Not found
- `422`: Validation Error

---

[API](https://skmtc.dev/usgs/apis/usgs-science-data-catalog-api-documentation.md) - [All operations](https://skmtc.dev/usgs/apis/usgs-science-data-catalog-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/usgs/apis/usgs-science-data-catalog-api-documentation/revisions/f5f6a07ba13f?raw)