Beta

List Comments (File)

QUERYhttps://api.youvico.com/api/files/:id/comments
Rate Limit
Default

Returns a file's comments.

Example

curl -X QUERY 'https://api.youvico.com/api/files/FX1234567890ABCD/comments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "sort": { "type": "createdAt", "direction": "asc" } }'
{
  "data": [
    {
      "id": "2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6",
      "content": "Please tighten the logo safe area.",
      "anchor": 12000,
      "duration": 3000,
      "createdAt": "2026-04-10 08:00:00.482913",
      "updatedAt": "2026-04-10 08:05:12.118204",
      "deletedAt": null,
      "reply": {
        "count": 1,
        "lastCreatedAt": "2026-04-10 08:10:00.215374"
      },
      "attachments": [
        {
          "id": "CA1234567890ABCD",
          "name": "review-note.pdf",
          "mimeType": "application/pdf",
          "size": 1250000
        }
      ],
      "reactions": [
        {
          "type": "๐Ÿ‘",
          "count": 2,
          "me": true
        }
      ],
      "parent": null,
      "author": {
        "id": "f6035d1a-29df-4d80-8d72-f1bbdddfb6ff",
        "name": "Jin Seo",
        "avatarUrl": "https://files.youvico.com/users/f6035d1a-29df-4d80-8d72-f1bbdddfb6ff/A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6.avif"
      }
    }
  ],
  "page": {
    "next": null,
    "prev": "WyIyMDI2LTA0LTEwIDA4OjAwOjAwLjQ4MjkxMyIsIjJmYjRlNjBiLTBkOWEtNDZmMy1hNGRjLWNiOWZlOGFkOWJlNiJd"
  }
}
Request
curl -X QUERY 'https://api.youvico.com/api/files/FX1234567890ABCD/comments' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"sort": {
"type": "createdAt",
"direction": "asc"
}
}'
Response200 OK
{
  "data": [
    {
      "id": "2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6",
      "content": "Please tighten the logo safe area.",
      "anchor": 12000,
      "duration": 3000,
      "createdAt": "2026-04-10 08:00:00.482913",
      "updatedAt": "2026-04-10 08:05:12.118204",
      "deletedAt": null,
      "reply": {
        "count": 1,
        "lastCreatedAt": "2026-04-10 08:10:00.215374"
      },
      "attachments": [
        {
          "id": "CA1234567890ABCD",
          "name": "review-note.pdf",
          "mimeType": "application/pdf",
          "size": 1250000
        }
      ],
      "reactions": [
        {
          "type": "๐Ÿ‘",
          "count": 2,
          "me": true
        }
      ],
      "parent": null,
      "author": {
        "id": "f6035d1a-29df-4d80-8d72-f1bbdddfb6ff",
        "name": "Jin Seo",
        "avatarUrl": "https://files.youvico.com/users/f6035d1a-29df-4d80-8d72-f1bbdddfb6ff/A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6.avif"
      }
    }
  ],
  "page": {
    "next": null,
    "prev": "WyIyMDI2LTA0LTEwIDA4OjAwOjAwLjQ4MjkxMyIsIjJmYjRlNjBiLTBkOWEtNDZmMy1hNGRjLWNiOWZlOGFkOWJlNiJd"
  }
}

Request

Path

idstringrequired
File ID

Body

sortobjectrequired
Sort order
sort.typestringrequired
Field to sort by

Possible values: createdAtanchor

Example: createdAt

sort.directionstringrequired
Sort direction

Possible values: ascdesc

Example: asc

keywordstring

2-255 characters

Search keyword
usersarray

1-20 items

Comment authors
users[].idstringrequired

UUID

Author user ID
hasAnchorboolean
Whether comments have an anchor
nextstring

Maximum 2048 characters

Cursor from page.next
prevstring

Maximum 2048 characters

Cursor from page.prev

Response

Returns 200 OK.

dataarray
Comments
data[].idstring
Comment ID

Example: 2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6

data[].contentstring?
Comment text

Example: Please tighten the logo safe area.

data[].anchornumber?
Video timestamp in milliseconds, or 1-based document page number

Example: 12000

data[].durationnumber?
Duration in the same unit as anchor

Example: 3000

data[].createdAtstring
Comment creation date

Example: 2026-04-10 08:00:00.482913

data[].updatedAtstring
Comment last updated date

Example: 2026-04-10 08:05:12.118204

data[].deletedAtstring?
Comment deletion date

Example: null

data[].replyobject
Reply summary
data[].attachmentsarray
Comment attachments
data[].reactionsarray
Reactions grouped by emoji
data[].parentobject?
Parent comment

Example: null

data[].authorobject?
Comment author
pageobject
Pagination cursors
page.nextstring?
Next page cursor

Example: null

page.prevstring?
Previous page cursor

Example: WyIyMDI2LTA0LTEwIDA4OjAwOjAwLjQ4MjkxMyIsIjJmYjRlNjBiLTBkOWEtNDZmMy1hNGRjLWNiOWZlOGFkOWJlNiJd