Sign in

v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Comment

Get Comment

Given a comment id, it returns all attributes of the comment

get/api/v2/core/comments/{commentId}

Path parameters

commentIdstring required

ID of comment in Eightfold

Query parameters

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

createdAtinteger nullable

Comment creation timestamp

entityTypestring nullable

Type of entity the comment is associated with

commentIdinteger nullable

Comment ID

isPrivateboolean nullable

Whether the comment is private

entityIdinteger nullable

ID of the entity the comment is associated with

createdBystring nullable

Email of the user who created the comment

parentIdinteger nullable

ID of the parent comment

groupIdstring nullable

Group ID

updatedAtinteger nullable

Comment update timestamp

commentstring nullable

Comment content in text (HTML) format