Skip to main content
GET
Get a comment for an entity and branch

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

commentId
string
required

Id of the comment

Pattern: ^comment(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Response

type
string
required

Entity type

id
string
required

Id of the comment

Pattern: ^comment(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
entityId
string
required

Id of the entity (policy, customer, branch, ...)

branchId
string
required

Id of the branch

Pattern: ^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
comment
string
required

Comment content

Maximum string length: 10000
createdAt
string<date-time>
required

Date and time when the comment was created

updatedAt
string<date-time>
required

Date and time when the comment was last updated

deletedAt
object | null

Date and time when the comment was soft-deleted

kind
enum<string>

Kind of comment (defaults to GENERIC)

Available options:
GENERIC,
NOTE
authorUserId
object | null

Cognito sub of the comment author (NOTE kind only)