{ "opencollection": "1.0.0", "info": { "name": "Regulations.gov comment submission utilities comments API", "version": "4.0" }, "request": { "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "items": [ { "info": { "name": "comments", "type": "folder" }, "items": [ { "info": { "name": "List of comments", "type": "http" }, "http": { "method": "GET", "url": "https://api.regulations.gov/v4/comments", "params": [ { "name": "filter[agencyId]", "value": "", "type": "query", "description": "'Filters results for the agency acronym specified in the value. Example: ''EPA'''" }, { "name": "filter[searchTerm]", "value": "", "type": "query", "description": "Filters results on the given term." }, { "name": "filter[postedDate]", "value": "", "type": "query", "description": "Filters results relative to the posted date. The value must be formatted as `yyyy-MM-dd`.

Omission of a parameter modifier will match results to the exact date provided, otherwise, one of the parameter modifiers below may be used.
`ge` - greater than or equal
`le` - less than or equal" }, { "name": "filter[lastModifiedDate]", "value": "", "type": "query", "description": "Filters results relative to the last modified date. The value must be formatted as `yyyy-MM-dd HH:mm:ss`.

Omission of a parameter modifier will match results to the exact date provided, otherwise, one of the parameter modifiers below may be used.
`ge` - greater than or equal
`le` - less than or equal" }, { "name": "filter[commentOnId]", "value": "", "type": "query", "description": "Filters results on the supplied commentOnId" }, { "name": "sort", "value": "", "type": "query", "description": "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.

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." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specifies the number for the page of results that will be returned from the query.

Acceptable values are numerical between, and including, 1 and 20." }, { "name": "page[size]", "value": "", "type": "query", "description": "Specifies the size per page of results that will be returned from the query.

Acceptable values are numerical between, and including, 5 and 250." } ] }, "docs": "This endpoint returns list of comments" }, { "info": { "name": "Get detailed information for specified commentId", "type": "http" }, "http": { "method": "GET", "url": "https://api.regulations.gov/v4/comments/:commentId", "params": [ { "name": "commentId", "value": "", "type": "path", "description": "ID of comment to return" }, { "name": "include", "value": "attachments", "type": "query", "description": "resources to include" } ] }, "docs": "Gets the detailed information of a specific comment with the passed commentId." } ] } ], "bundled": true }