Skip to content

List Project Comments Tier 4

GET/api/projects/:id/commentsCopied!

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

Example

ts
const comments = await client.comments.listForProject("bdbff5de-96d7-468f-9db0-85fe28bd6b62");
bash
youvico comment list --project bdbff5de-96d7-468f-9db0-85fe28bd6b62
bash
curl 'https://api.youvico.com/api/projects/bdbff5de-96d7-468f-9db0-85fe28bd6b62/comments' \
  -H 'Authorization: Bearer YOUR_API_KEY'
json
{
  "data": [
    {
      "id": "2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6",
      "content": "Project brief is ready for review.",
      "anchor": null,
      "duration": null,
      "createdAt": "2026-04-10 08:00:00.000000",
      "updatedAt": "2026-04-10 08:10:00.000000",
      "attachments": [],
      "author": {
        "id": "f6035d1a-29df-4d80-8d72-f1bbdddfb6ff",
        "name": "Jin Seo",
        "avatarUrl": "https://cdn.youvico.com/users/f6035d1a-29df-4d80-8d72-f1bbdddfb6ff/A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6.avif"
      }
    }
  ],
  "page": {
    "next": null,
    "prev": "MjAyNi0wNC0xMFQwODowMDowMC4wMDBa"
  }
}

INFO

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

Request

Path

idstringrequired
Project 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 project comments are returned.

Response

Returns 200 OK.

dataarray
Comments
data[].idstring
Comment ID

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

data[].contentstring?
Comment text

Example: Project brief is ready for review.

data[].anchornumber?
Always `null` for project comments

Example: null

data[].durationnumber?
Always `null` for project comments

Example: null

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[].attachmentsarray
Comment attachments
data[].attachments[].idstring
Comment attachment ID

Example: CA1234567890ABCD

data[].attachments[].namestring
Attachment file name

Example: review-note.pdf

data[].attachments[].urlstring
Attachment URL

Example: https://cdn.youvico.com/workspaces/6ba7b810-9dad-11d1-80b4-00c04fd430c8/projects/bdbff5de-96d7-468f-9db0-85fe28bd6b62/comments/CA1234567890ABCD/A1b2C3d4E5f6G7h8.pdf

data[].attachments[].mimeTypestring?
Attachment MIME type

Example: application/pdf

data[].attachments[].sizenumber
Attachment size in bytes

Example: 1250000

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/users/f6035d1a-29df-4d80-8d72-f1bbdddfb6ff/A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6.avif

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

Example: null

page.prevstring?
Cursor for the previous page

Example: MjAyNi0wNC0xMFQwODowMDowMC4wMDBa