v25

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-22103759.4 KB
documents

List of documents

This endpoint returns list of documents

get/documents

Query parameters

filter[agencyId]string

'Filters results for the agency acronym specified in the value. Example: ''EPA'''

filter[commentEndDate]string date

Filters results relative to the comment end date. The value must be formatted as yyyy-MM-dd.<br/><br/> Omission of a parameter modifier will match results to the exact date provided, otherwise, one of the parameter modifiers below may be used. <br/> ge - greater than or equal <br/> le - less than or equal

filter[docketId]string

Filters results on the specified docket ID.

filter[documentType]'Notice' | 'Rule' | 'Proposed Rule' | 'Supporting & Related Material' | 'Other'

type of document. This field is always returned in JSON response

Filters results on the specified document type.

filter[frDocNum]string

Filters results on the specified frDocNum.

filter[searchTerm]string

Filters results on the given term.

filter[postedDate]string date

Filters results relative to the posted date. The value must be formatted as yyyy-MM-dd.<br/><br/> Omission of a parameter modifier will match results to the exact date provided, otherwise, one of the parameter modifiers below may be used. <br/> ge - greater than or equal <br/> le - less than or equal

filter[lastModifiedDate]string date

Filters results relative to the last modified date. The value must be formatted as yyyy-MM-dd HH:mm:ss.<br/><br/> Omission of a parameter modifier will match results to the exact date provided, otherwise, one of the parameter modifiers below may be used. <br/> ge - greater than or equal <br/> le - less than or equal

filter[subtype]string

Filters results on the supplied document subtype

filter[withinCommentPeriod]boolean

Filters results for documents that are open for comment by setting the value to true. <br/><br/> False is not an acceptable value for this parameter, hence it should be removed when not being used.

sortstring

Sorts the results on the field specified in the value. The default behavior will sort the results in ascending order; to sort in descending order, prepend a minus sign to the value. <br/><br/> Supported values are commentEndDate, postedDate, lastModifiedDate, documentId and title. Multiple sort options can be passed in as a comma separated list to sort results by multiple fields.

page[number]integer

Specifies the number for the page of results that will be returned from the query. <br/><br/> Acceptable values are numerical between, and including, 1 and 20.

page[size]integer

Specifies the size per page of results that will be returned from the query. <br/><br/> Acceptable values are numerical between, and including, 5 and 250.

Response

A JSON:API document with the a list of documents

All 10 operations