v4

latestSwagger 2.02026-08-0343714211.7 MB

file_comments

File Comments

List File Comments by Path

get/file_comments/files/{path}

Path parameters

pathstring required

Path to operate on.

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

Response

A list of FileComments objects.

idinteger

File Comment ID

bodystring

Comment body.

Example response

[
  {
    "id": 1,
    "body": "What a great file!",
    "reactions": [
      {
        "id": 1,
        "emoji": "👍"
      }
    ]
  }
]