Skip to content

List Comments Tier 4

GET/api/versions/:id/commentsCopied!

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

Request

Path

idstringrequired
Version 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[].startTimenumber?
Start timestamp. Milliseconds for video/YouTube, page number for PDF/Image

Example: 12400

data[].endTimenumber?
End timestamp. Milliseconds for video/YouTube, page number for PDF/Image

Example: 18900

data[].drawingboolean?
Whether a drawing is attached

Example: true

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[].versionobject
Parent version
data[].version.idstring
Parent version ID

Example: 8fe89e5a-1d8f-4302-8437-fb0390ecf8eb

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

Example

bash
curl 'https://api.youvico.com/api/versions/8fe89e5a-1d8f-4302-8437-fb0390ecf8eb/comments' \
  -H 'Authorization: Bearer YOUR_API_KEY'
json
{
  "data": [
    {
      "id": "2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6",
      "content": "Please tighten the logo safe area.",
      "startTime": 12400,
      "endTime": 18900,
      "drawing": true,
      "createdAt": "2026-04-10 08:00:00.000000",
      "updatedAt": "2026-04-10 08:10:00.000000",
      "version": {
        "id": "8fe89e5a-1d8f-4302-8437-fb0390ecf8eb"
      },
      "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, startTime, endTime, drawing, and author are null.