v1

latestOpenAPI 3.1.02026-07-1744202324.0 KB
Comments

Get comments in a file

Gets a list of comments left on the file.

get/v1/files/{file_key}/comments

Path parameters

file_keystring required

File to get comments from. This can be a file key or branch key. Use GET /v1/files/:key with the branch_data query param to get the branch key.

Query parameters

as_mdboolean

If enabled, will return comments as their markdown equivalents when applicable.

Response

Response from the GET /v1/files/{file_key}/comments endpoint.