---
title: "OpenFEMA Data Set Fields"
method: GET
path: "/v1/DataSetFields"
tags: ["Miscellaneous"]
---

# OpenFEMA Data Set Fields

`GET /v1/DataSetFields`

## Request

- Base URL: `https://www.fema.gov/api/open`
- URL: `https://www.fema.gov/api/open/v1/DataSetFields`
- Auth: none declared
- TypeScript: <https://skmtc.dev/fema/apis/openfema-api/docs/v1/DataSetFields/get.ts> (a function with typed inputs; its response is checked against the schema)

Metadata for the OpenFEMA API data set fields. It contains descriptions, data types, and other attributes for each field.

Citation: FEMA's citation requirements for datasets (API usage or file downloads) can be found on the OpenFEMA Terms and Conditions page, Citing Data section: https://www.fema.gov/about/openfema/terms-conditions.

For answers to Frequently Asked Questions (FAQs) about the OpenFEMA program, API, and publicly available datasets, please visit: https://www.fema.gov/about/openfema/faq.
If you have media inquiries about this dataset, please email the FEMA Press Office at FEMA-Press-Office@fema.dhs.gov. For inquiries about FEMA's data and Open Government program, please email the OpenFEMA team at OpenFEMA@fema.dhs.gov.

## Query parameters

- `$filter` string
- `$top` integer
- `$skip` integer
- `$count` boolean
- `$filename` string
- `$metadata` boolean
- `$gzip` boolean
- `$orderby` string[]
- `$select` string[]
- `$format` 'json' | 'jsona' | 'csv' | 'jsonl' | 'parquet'

## Response `200`

OK

- object
  - `metadata` Metadata
    - `skip` number, nullable
    - `filter` string, nullable
    - `orderBy` string, nullable
    - `select` string, nullable
    - `rundate` string, nullable
    - `top` number, nullable
    - `format` string, nullable
    - `metadata` boolean, nullable
    - `entityname` string
    - `version` string
    - `url` string
    - `count` number, nullable
  - `DataSetFields` V1DataSetFields[]
    - `datasetId` string, string: Unique, textual identifier for a dataset.
    - `name` string, string: Name of the field.
    - `openFemaDataSet` string, string: Name of Open FEMA Data Set for which the field belongs.
    - `datasetVersion` number: Major version number of the dataset API endpoint. Version number does not change when additional fields are added to an existing dataset. Data type changes and field deletions will necessitate a version number change.
    - `title` string, string: Display title of the field.
    - `description` string, string: Description of the field.
    - `type` string, string: Data type of the field (string, date, number).
    - `sortOrder` number: Display order for the fields.
    - `isSearchable` boolean: True indicates the field is searchable/can be used as a filter.
    - `isNestedObject` boolean: True indicates the field is a nested object that may contain related sub-attributes.
    - `isNullable` boolean: True indicates the field can contain null fields. Unless described differently in the specific dataset field description, null means unknown or no data is available.
    - `srid` number, nullable
    - `primaryKey` boolean, nullable: Defines if this field is or is part of a unique identifier (primary key) for this dataset. The number indicates this fields order in the key participation.
    - `lastRefresh` string, date-time: Last date the dataset was updated in the datastore
    - `hash` string, string: MD5 hash of fields and values of the record
    - `id` string, string: Unique ID assigned to this record.

---

[API](https://skmtc.dev/fema/apis/openfema-api.md) - [All operations](https://skmtc.dev/fema/apis/openfema-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fema/apis/openfema-api/revisions/fdc02603897f?raw)