GET

/api/v1/documents/{DocumentId}/versions/{VersionId}/comments

http://workdocs.{region}.amazonaws.com/api/v1/documents/{DocumentId}/versions/{VersionId}/comments

List all the comments for the specified document version.

Access Token Required: API Key

Path Parameters

DocumentIdstringrequired

The ID of the document.

VersionIdstringrequired

The ID of the document version.

Query Params

limitinteger

The maximum number of items to return.

markerstring

The marker for the next set of results. This marker was received from a previous call.

Limitstring

Pagination limit

Markerstring

Pagination token

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://workdocs.{region}.amazonaws.com/api/v1/documents/{DocumentId}/versions/{VersionId}/comments' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET