Skip to main content
Retrieve a composition comment

Authorizations

Authorization
string
header
required

A Tightknit admin API key, sent as Authorization: Bearer <key>.

Path Parameters

composition_comment_id
string
required

The composition comment's id.

Pattern: ^cpcm_[a-zA-Z0-9]{12}$

Query Parameters

expand

Repeatable. Returns the named relation inline. One of: created_by, updated_by, resolved_by.

Available options:
created_by,
updated_by,
resolved_by

Response

Success

object
enum<string>
required

Always composition_comment.

Available options:
composition_comment
id
string
required

Unique identifier for the object.

Example:

"cpcm_3g6j9l2n5q8s"

created_at
string<date-time>
required

When the object was created.

updated_at
string<date-time>
required

When the object was last changed.

composition_id
string
required

The id of the composition it is about.

Example:

"cmps_7h2k9m4n1p6q"

parent_comment_id
string | null
required

The id of the comment that starts its thread. Null for a comment that starts one.

composition_version_id
string | null
required

The id of the version it was written on. Null once that version is pruned.

body
string
required

The plaintext rendering of what it says.

block_id
string | null
required

The block_id of the block its thread is about. Null for a comment on the whole composition, and for a reply.

edited_at
string<date-time> | null
required

When its author last changed it. Null when never edited.

resolved_at
string<date-time> | null
required

When its thread was resolved. Null while open, and always for a reply.

resolved_by_id
string | null
required

The id of the profile that resolved its thread. Null while open, or once that profile is deleted.

created_by_id
string | null
required

The id of the profile that wrote it. Null once that profile is deleted.

updated_by_id
string | null
required

The id of the profile that last changed it. Null once that profile is deleted.

resolved_by
object | null

The profile that resolved its thread. Present only when resolved_by is expanded.

created_by
object | null

The profile that wrote it. Present only when created_by is expanded.

updated_by
object | null

The profile that last changed it. Present only when updated_by is expanded.