Skip to main content
Get a comment

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as author.user_id. id is always returned. Fields: type, id, entity_type, entity_id, parent_comment_id, body, author, occurred_at, updated_at, reply_count.

Response

The comment, owning entity, author and reply count.

type
enum<string>
required
Available options:
comment
id
string<uuid>
required
entity_type
enum<string>
required
Available options:
invoice,
agreement,
alert,
claim
entity_id
string<uuid>
required
parent_comment_id
string<uuid> | null
required
body
string
required
author
object
required
occurred_at
string<date-time>
required
updated_at
string<date-time>
required
reply_count
integer
required
Required range: x >= 0