comments

Get detailed information for specified commentId

Changed on Feb 2, 2021

Gets the detailed information of a specific comment with the passed commentId.

get/comments/{commentId}

Request

Base URL
https://api.regulations.gov/v4
Auth
API key in header X-Api-Key
TypeScript
https://skmtc.dev/gsa/apis/regulations-gov-api/docs/comments/:commentId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

commentIdstring required

ID of comment to return

Query parameters

includestring

resources to include

Response

successful operation

idstring

The JSON:API resource ID (documentId of the comment). DocumentId field is always returned in JSON response. This is an agency configurable field. Each agency has option to configure the format of the field.

typestring

The JSON:API resource type comments

Changes

Feb 2, 2021v416c703ef3a32 Revision changes
- info
  added the optional property ///// to the response with the status

Operation history