v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-15367117899.6 KB
Comments

Get comments for an entity

Get comments for an entity in Betayum. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.

get/v1/comments

Query parameters

entityIdstring required
Example:tsk_abc123def456

ID of the entity to get comments for

entityType'task' | 'vendor' | 'risk' | 'policy' | 'finding' required

Type of entity

Response

Comments retrieved successfully

idstring required

Unique identifier for the comment

contentstring required

Comment content

createdAtstring date-time required

Comment creation timestamp

Example response

[
  {
    "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"
    },
    "attachments": [
      {
        "id": "att_abc123def456",
        "name": "document.pdf",
        "type": "application/pdf",
        "createdAt": "2024-01-15T10:30:00Z"
      }
    ],
    "createdAt": "2024-01-15T10:30:00Z"
  }
]