List Comment Examples

curl --request GET \
  --url https://prod-nginx-v2.goextrovert.com/webgateway/api/client/v2/comment-example \
  --header 'X-API-Key: <api-key>'

{
  "status": "success",
  "data": [
    {
      "id": "8d256aa6-9b12-49a7-93ee-bf41634b5b60",
      "updatedAt": "2025-06-30T14:02:07.456Z",
      "createdAt": "2025-06-30T14:02:07.456Z",
      "text": "<string>",
      "styleId": "cf33282b-b171-4d23-ae02-848499d793e4"
    }
  ],
  "message": "Operation completed successfully"
}

Comment Examples

List Comment Examples

Returns all CommentExample entries attached to the given Style. A CommentExample is a full sample comment (either captured by the backend from the user’s real activity, or added manually) that is used as a writing-style sample when generating comments under that Style. Entries appear via two paths: (1) automatically — when the parent Style has isLearningModeEnabled: true, the backend captures the user’s edited-and-approved comments; (2) manually — by creating an entry directly. When a Style has fewer than 20 entries the platform also fills in additional built-in samples at generation time — those are NOT returned here.

GET

api

client

comment-example

List Comment Examples

curl --request GET \
  --url https://prod-nginx-v2.goextrovert.com/webgateway/api/client/v2/comment-example \
  --header 'X-API-Key: <api-key>'

{
  "status": "success",
  "data": [
    {
      "id": "8d256aa6-9b12-49a7-93ee-bf41634b5b60",
      "updatedAt": "2025-06-30T14:02:07.456Z",
      "createdAt": "2025-06-30T14:02:07.456Z",
      "text": "<string>",
      "styleId": "cf33282b-b171-4d23-ae02-848499d793e4"
    }
  ],
  "message": "Operation completed successfully"
}

Authorizations

X-API-Key

string

header

required

API Key for authentication

Query Parameters

string<uuid>

required

ID of the Style whose CommentExamples should be returned.

Response

status

enum<string>

required

Response status

Available options:

success

data

object[]

required

CommentExample entries attached to the requested Style

Show child attributes

message

string

required

Success message

Example:

"Operation completed successfully"

Delete Prospect List Create Comment Example