English
Appearance
Returns top-level comments for a file, ordered by creation time. Uses cursor pagination.
const comments = await client.comments.list("FX1234567890ABCD");
youvico comment list --file FX1234567890ABCD
curl 'https://api.youvico.com/api/files/FX1234567890ABCD/comments' \ -H 'Authorization: Bearer YOUR_API_KEY'
{ "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.
content
anchor
duration
author
null
id
string
next
prev
If neither next nor prev is specified, the 25 most recently created comments are returned.
Returns 200 OK.
200 OK
data
array
data[].id
Example: 2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6
2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6
data[].content
string?
Example: Please tighten the logo safe area.
Please tighten the logo safe area.
data[].anchor
number?
Example: 12
12
data[].duration
Example: 12400
12400
data[].createdAt
Example: 2026-04-10 08:00:00.000000
2026-04-10 08:00:00.000000
data[].updatedAt
Example: 2026-04-10 08:10:00.000000
2026-04-10 08:10:00.000000
data[].author
object?
data[].author.id
Example: f6035d1a-29df-4d80-8d72-f1bbdddfb6ff
f6035d1a-29df-4d80-8d72-f1bbdddfb6ff
data[].author.name
Example: Jin Seo
Jin Seo
data[].author.avatarUrl
Example: https://cdn.youvico.com/avatar/jin.png
https://cdn.youvico.com/avatar/jin.png
page
object
page.next
Example: null
page.prev
Example: MjAyNi0wNC0xMFQwODowMDowMC4wMDBa
MjAyNi0wNC0xMFQwODowMDowMC4wMDBa
List Comments Tier 4
Returns top-level comments for a file, ordered by creation time. Uses cursor pagination.
Example
INFO
Deleted top-level comments may still appear if they have surviving replies. When a deleted comment is returned,
content,anchor,duration, andauthorarenull.Request
Path
idstringrequiredQuery
nextstringprevstringINFO
If neither
nextnorprevis specified, the 25 most recently created comments are returned.Response
Returns
200 OK.dataarraydata[].idstringExample:
2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6data[].contentstring?Example:
Please tighten the logo safe area.data[].anchornumber?Example:
12data[].durationnumber?Example:
12400data[].createdAtstringExample:
2026-04-10 08:00:00.000000data[].updatedAtstringExample:
2026-04-10 08:10:00.000000data[].authorobject?data[].author.idstringExample:
f6035d1a-29df-4d80-8d72-f1bbdddfb6ffdata[].author.namestringExample:
Jin Seodata[].author.avatarUrlstring?Example:
https://cdn.youvico.com/avatar/jin.pngpageobjectpage.nextstring?Example:
nullpage.prevstring?Example:
MjAyNi0wNC0xMFQwODowMDowMC4wMDBa