Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EPA — U.S. Environmental Protection Agency Formio API

The Formio API from EPA — U.S. Environmental Protection Agency — 43 operation(s) for formio.

EPA — U.S. Environmental Protection Agency Formio API is one of 137 APIs that EPA — U.S. Environmental Protection Agency publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1242 JSON Schema definitions.

Tagged areas include Formio. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1242 JSON Schemas.

This API exposes 58 operations across 43 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://aqs.epa.gov/data/api.

58 operations 43 paths 1 schemas 3 DELETE34 GET21 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://aqs.epa.gov/data/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

EPA — U.S. Environmental Protection Agency Formio API declares 1 security scheme for authenticating requests. An API key is passed in the query as key (emailKey). By default, every request must be authenticated.

  • emailKey — AQS requires email and key query parameters on every request. Register at /signup?email=YOUREMAIL to receive a key by email.

Paths & Operations 58

Across 43 paths, the API surfaces 58 operations — 3 DELETE, 34 GET, 21 POST. Each is listed below with its method, path, parameters, and response codes.

Formio 58
GET
/api/formio/2022/district/{rebateId}
Get the School District Info Associated with a Provided CSB Rebate ID
1 param → 200401
GET
/api/formio/2022/s3/{formType}/{mongoId}/{comboKey}/storage/s3
Download Formio File Attachment from S3 for a 2022 Submission.
5 params → 200401
POST
/api/formio/2022/s3/{formType}/{mongoId}/{comboKey}/storage/s3
Upload Formio File Attachment to S3 for a 2022 Submission.
3 params body → 200401
DELETE
/api/formio/2022/s3/{formType}/{mongoId}/{comboKey}/storage/s3
Delete Formio File Attachment from S3 for a 2022 Submission.
3 params → 200401
GET
/api/formio/2022/pdf/{formType}/{mongoId}
Download a PDF of a 2022 Form Submission.
2 params → 200401
GET
/api/formio/2022/frf-submissions
Get User's 2022 FRF Submissions from Formio.
→ 200401
POST
/api/formio/2022/frf-submission
Post a New 2022 FRF Submission to Formio.
body → 200401
GET
/api/formio/2022/frf-submission/{mongoId}
Get an Existing 2022 FRF's Schema and Submission Data from Formio.
1 param → 200401
POST
/api/formio/2022/frf-submission/{mongoId}
Post an Update to an Existing Draft 2022 FRF Submission to Formio.
1 param body → 200401
GET
/api/formio/2022/prf-submissions
Get User's 2022 PRF Submissions from Formio.
→ 200401
POST
/api/formio/2022/prf-submission
Post a New 2022 PRF Submission to Formio.
body → 200401
GET
/api/formio/2022/prf-submission/{rebateId}
Get an Existing 2022 PRF's Schema and Submission Data from Formio.
1 param → 200401
POST
/api/formio/2022/prf-submission/{rebateId}
Post an Update to an Existing Draft 2022 PRF Submission to Formio.
1 param body → 200401
POST
/api/formio/2022/delete-prf-submission
Delete an Existing 2022 PRF Submission from Formio.
body → 200401
GET
/api/formio/2022/crf-submissions
Get User's 2022 CRF Submissions from Formio.
→ 200401
POST
/api/formio/2022/crf-submission
Post a New 2022 CRF Submission to Formio.
body → 200401
GET
/api/formio/2022/crf-submission/{rebateId}
Get an Existing 2022 CRF's Schema and Submission Data from Formio.
1 param → 200401
POST
/api/formio/2022/crf-submission/{rebateId}
Post an Update to an Existing Draft 2022 CRF Submission to Formio.
1 param body → 200401
GET
/api/formio/2022/changes
Get User's 2022 Change Request Form Submissions from Formio.
→ 200401
GET
/api/formio/2023/check-vin/{vin}
Check for Duplicate VINs in the BAP.
3 params → 200401
GET
/api/formio/2023/nces/{searchText}
Search 2023 NCES Data with the Provided NCES ID and Return a Match.
1 param → 200401
GET
/api/formio/2023/district/{rebateId}
Get the School District Info Associated with a Provided CSB Rebate ID
1 param → 200401
GET
/api/formio/2023/contacts/{rebateId}
Get Contacts Associated with a Provided CSB Rebate ID
1 param → 200401
GET
/api/formio/2023/s3/{formType}/{mongoId}/{comboKey}/storage/s3
Download Formio File Attachment from S3 for a 2023 Submission.
5 params → 200401
POST
/api/formio/2023/s3/{formType}/{mongoId}/{comboKey}/storage/s3
Upload Formio File Attachment to S3 for a 2023 Submission.
3 params body → 200401
DELETE
/api/formio/2023/s3/{formType}/{mongoId}/{comboKey}/storage/s3
Delete Formio File Attachment from S3 for a 2023 Submission.
3 params → 200401
GET
/api/formio/2023/pdf/{formType}/{mongoId}
Download a PDF of a 2023 Form Submission.
2 params → 200401
GET
/api/formio/2023/frf-submissions
Get User's 2023 FRF Submissions from Formio.
→ 200401
POST
/api/formio/2023/frf-submission
Post a New 2023 FRF Submission to Formio.
body → 200401
GET
/api/formio/2023/frf-submission/{mongoId}
Get an Existing 2023 FRF's Schema and Submission Data from Formio.
1 param → 200401
POST
/api/formio/2023/frf-submission/{mongoId}
Post an Update to an Existing Draft 2023 FRF Submission to Formio.
1 param body → 200401
GET
/api/formio/2023/prf-submissions
Get User's 2023 PRF Submissions from Formio.
→ 200401
POST
/api/formio/2023/prf-submission
Post a New 2023 PRF Submission to Formio.
body → 200401
GET
/api/formio/2023/prf-submission/{rebateId}
Get an Existing 2023 PRF's Schema and Submission Data from Formio.
1 param → 200401
POST
/api/formio/2023/prf-submission/{rebateId}
Post an Update to an Existing Draft 2023 PRF Submission to Formio.
1 param body → 200401
POST
/api/formio/2023/delete-prf-submission
Delete an Existing 2023 PRF Submission from Formio.
body → 200401
GET
/api/formio/2023/crf-submissions
Get User's 2023 CRF Submissions from Formio.
→ 200401
POST
/api/formio/2023/crf-submission
Post a New 2023 CRF Submission to Formio.
body → 200401
GET
/api/formio/2023/crf-submission/{rebateId}
Get an Existing 2023 CRF's Schema and Submission Data from Formio.
1 param → 200401
POST
/api/formio/2023/crf-submission/{rebateId}
Post an Update to an Existing Draft 2023 CRF Submission to Formio.
1 param body → 200401
GET
/api/formio/2023/changes
Get User's 2023 Change Request Form Submissions from Formio.
→ 200401
GET
/api/formio/2023/change
Get the 2023 Change Request Form's Schema from Formio.
→ 200401
POST
/api/formio/2023/change
Post a New 2023 Change Request Form Submission to Formio.
body → 200401
GET
/api/formio/2023/change/{mongoId}
Get an Existing 2023 Change Request Form's Schema and Submission Data from Formio.
1 param → 200401
GET
/api/formio/2024/nces/{searchText}
Search 2024 NCES Data with the Provided NCES ID and Return a Match.
1 param → 200401
GET
/api/formio/2024/district/{rebateId}
Get the School District Info Associated with a Provided CSB Rebate ID
1 param → 200401
GET
/api/formio/2024/s3/{formType}/{mongoId}/{comboKey}/storage/s3
Download Formio File Attachment from S3 for a 2024 Submission.
5 params → 200401
POST
/api/formio/2024/s3/{formType}/{mongoId}/{comboKey}/storage/s3
Upload Formio File Attachment to S3 for a 2024 Submission.
3 params body → 200
DELETE
/api/formio/2024/s3/{formType}/{mongoId}/{comboKey}/storage/s3
Delete Formio File Attachment from S3 for a 2024 Submission.
3 params → 200401
GET
/api/formio/2024/pdf/{formType}/{mongoId}
Download a PDF of a 2024 Form Submission.
2 params → 200401
GET
/api/formio/2024/frf-submissions
Get User's 2024 FRF Submissions from Formio.
→ 200401
POST
/api/formio/2024/frf-submission
Post a New 2024 FRF Submission to Formio.
body → 200401
GET
/api/formio/2024/frf-submission/{mongoId}
Get an Existing 2024 FRF's Schema and Submission Data from Formio.
1 param → 200401
POST
/api/formio/2024/frf-submission/{mongoId}
Post an Update to an Existing Draft 2024 FRF Submission to Formio.
1 param body → 200401
GET
/api/formio/2024/changes
Get User's 2024 Change Request Form Submissions from Formio.
→ 200401
GET
/api/formio/2024/change
Get the 2024 Change Request Form's Schema from Formio.
→ 200401
POST
/api/formio/2024/change
Post a New 2024 Change Request Form Submission to Formio.
body → 200401
GET
/api/formio/2024/change/{mongoId}
Get an Existing 2024 Change Request Form's Schema and Submission Data from Formio.
1 param → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is FormioSchemaAndSubmission (3 properties). Each schema is shown below with its type and property counts.

FormioSchemaAndSubmission
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

epa-formio-api-openapi.yml Raw ↑

Other APIs EPA — U.S. Environmental Protection Agency publishes across the network.

EPA Facility Registry Service (FRS) API
EPA TRI (Toxics Release Inventory) Web Service
EPA ATTAINS Web Services
EPA WATERS — Watershed Assessment, Tracking & Environmental Results
EPA Grants API
EPA Insect Repellents API
EPA e-Manifest Hazardous Waste Tracking
EPA System of Registries (SoR)
CTX — Center for Computational Toxicology and Exposure APIs
EPA — U.S. Environmental Protection Agency Account Type Codes API
EPA — U.S. Environmental Protection Agency Accounts API
EPA — U.S. Environmental Protection Agency Air Emission Testing API