Skip to main content
GET
/
v1
/
comments
Get comments for an entity
curl --request GET \
  --url https://api.trycomp.ai/v1/comments \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "cmt_abc123def456",
    "content": "This task needs to be completed by end of week",
    "author": {
      "id": "usr_abc123def456",
      "name": "John Doe",
      "email": "john.doe@company.com",
      "image": "https://example.com/avatar.jpg",
      "deactivated": false
    },
    "attachments": [
      {
        "id": "att_abc123def456",
        "name": "document.pdf",
        "type": "application/pdf",
        "createdAt": "2024-01-15T10:30:00Z"
      }
    ],
    "createdAt": "2024-01-15T10:30:00Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://www.trycomp.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Query Parameters

​
entityId
string
required

ID of the entity to get comments for

Example:

"tsk_abc123def456"

​
entityType
enum<string>
required

Type of entity

Available options:
task,
vendor,
risk,
policy,
finding

Response

200 - application/json

Comments retrieved successfully

​
id
string
required

Unique identifier for the comment

Example:

"cmt_abc123def456"

​
content
string
required

Comment content

Example:

"This task needs to be completed by end of week"

​
author
object
required

Comment author information

​
attachments
object[]
required

Attachment metadata (URLs generated on-demand)

​
createdAt
string<date-time>
required

Comment creation timestamp

Example:

"2024-01-15T10:30:00Z"