Skip to content

List Comments Tier 4

GET/api/files/:id/commentsCopied!

Returns top-level comments for a file, ordered by creation time. Uses cursor pagination.

Example

ts
const comments = await client.comments.list("FX1234567890ABCD");
bash
youvico comment list --file FX1234567890ABCD
bash
curl 'https://api.youvico.com/api/files/FX1234567890ABCD/comments' \
  -H 'Authorization: Bearer YOUR_API_KEY'
json
{
  "data": [
    {
      "id": "2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6",
      "content": "Please tighten the logo safe area.",
      "anchor": null,
      "duration": 12400,
      "createdAt": "2026-04-10 08:00:00.000000",
      "updatedAt": "2026-04-10 08:10:00.000000",
      "author": {
        "id": "f6035d1a-29df-4d80-8d72-f1bbdddfb6ff",
        "name": "Jin Seo",
        "avatarUrl": "https://cdn.youvico.com/avatar/jin.png"
      }
    }
  ],
  "page": {
    "next": null,
    "prev": "MjAyNi0wNC0xMFQwODowMDowMC4wMDBa"
  }
}

INFO

Deleted top-level comments may still appear if they have surviving replies. When a deleted comment is returned, content, anchor, duration, and author are null.

Request

Path

idstringrequired
File ID

Query

nextstring
Cursor for the next page
prevstring
Cursor for the previous page

INFO

If neither next nor prev is specified, the 25 most recently created comments are returned.

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?
Playback position associated with the comment

Example: 12

data[].durationnumber?
Timestamp or duration value associated with the comment

Example: 12400

data[].createdAtstring
Comment creation date

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

data[].updatedAtstring
Comment last updated date

Example: 2026-04-10 08:10:00.000000

data[].authorobject?
Comment author
data[].author.idstring
Author user ID

Example: f6035d1a-29df-4d80-8d72-f1bbdddfb6ff

data[].author.namestring
Author display name

Example: Jin Seo

data[].author.avatarUrlstring?
Author avatar URL

Example: https://cdn.youvico.com/avatar/jin.png

pageobject
Pagination cursors
page.nextstring?
Cursor for the next page

Example: null

page.prevstring?
Cursor for the previous page

Example: MjAyNi0wNC0xMFQwODowMDowMC4wMDBa