latestOpenAPI 3.0.22026-08-1451965.7 KB

f5a72ed18934

Bulk export

Start a bulk export job

Start a bulk export job. Returns 202 with a job_id to poll.

At least one filter field must be set — unfiltered exports would scan the entire employer table and are refused.

post/v1/export

Headers

X-Api-Keystring

Request body

formatstring

Output format: csv or json (NDJSON)

max_rowsinteger

Row cap, 1–100,000

sort_bystring

One of: employer_id, fatalities, inspections, penalties, violations, whd_backwages, whd_cases

sort_dirstring

asc or desc

Example request

{
  "filters": {
    "has_fatalities": true,
    "min_penalties": 100000,
    "naics_codes": [
      "2361",
      "2362"
    ],
    "states": [
      "CA",
      "TX",
      "FL"
    ]
  },
  "format": "csv",
  "max_rows": 50000,
  "sort_by": "fatalities",
  "sort_dir": "desc"
}

Response

Successful Response

{"stackTrail":"paths:/v1/export:post:responses:202:content:application/json:schema","oasType":"schema","type":"unknown"}