v25

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

List of comments

This endpoint returns list of comments

get/comments

Query parameters

filter[agencyId]string

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

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[commentOnId]string

Filters results on the supplied commentOnId

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/> The only supported values are postedDate, lastModifiedDate and documentId. 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 comments