List engagement transcript comments

View as Markdown

Returns transcript comments for a workspace engagement’s primary transcript timeline. Requires both engagements:read and transcript_comments:read scopes. Reading transcript comments for a private engagement also requires engagements:private:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

engagement_idstringRequired

Response headers

X-RateLimit-Limitinteger

Maximum number of authenticated requests allowed for the workspace in the current 60-second window. The limit is 1000 and applies to all /api/v2 resource routes (GET, POST, PATCH, and DELETE), shared across every credential for the workspace.

X-RateLimit-Remaininginteger
Number of requests remaining in the current window before the limit is exceeded.
X-RateLimit-Resetinteger

Unix epoch seconds when the current rate-limit window resets.

X-Api-VersionstringOptional

Response

Transcript comment list response.
objectenum
Allowed values:
datalist of objects
has_moreboolean
next_cursorstring or null

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error