GET /v1/files/{file_key}/comments

Gets a list of comments left on the file.

Servers

Path parameters

Name Type Required Description
file_key String Yes

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

Name Type Required Description
as_md Boolean No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.