Sign in

v1

latestOpenAPI 3.1.02026-07-2416666272.6 KB
Public - Comments

List comments

Returns the list of video comments with pagination.

Authentication

ParameterTypeDescription
link_idpathReview link identifier
tokenqueryUser session token

The token is required to access comments. This same token can be used to edit or delete comments that were created with it. The token can be the same value as link_id or a unique identifier generated by the application.

Example: 550e8400-e29b-41d4-a716-446655440000

Behavior

  • Returns main comments with their nested replies
  • Supports pagination via page and limit
  • Allows filtering by status (open/resolved)
  • If the link has show_resolved: false, only open comments are returned

Response Structure

Comments are returned in hierarchical format, where each main comment contains a replies array with its responses.

get/public-video-review/{link_id}/comments

Path parameters

link_idstring uuid required

Review link UUID

Query parameters

tokenstring uuid required

User session token. Use the same token to edit or delete comments you created.

pagestring

Page number (default 1)

limitstring

Items per page (1-100, default 10)

status'open' | 'resolved'

Filter by comment status

Response

Comment list returned successfully

hasNextPageboolean

Indicates if there is a next page of results.

totalPagesinteger

Total number of available pages.

pageinteger

Current page number.

limitinteger

Number of items per page.

totalItensinteger

Total number of main comments (does not include replies in count).

Example response

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "video_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "user_id": "1b4f677f-4f6e-459d-84e0-7c304d3dbf48",
      "user_name": "John Smith",
      "text": "The audio is low in this section.",
      "status": "open",
      "time": 330,
      "avatar": "https://cdn.pandavideo.com.br/avatars/user123.jpg",
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:30:00.000Z",
      "replies": [
        {
          "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
          "video_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "user_id": "1b4f677f-4f6e-459d-84e0-7c304d3dbf48",
          "user_name": "John Smith",
          "text": "The audio is low in this section.",
          "status": "open",
          "time": 330,
          "avatar": "https://cdn.pandavideo.com.br/avatars/user123.jpg",
          "created_at": "2025-01-15T10:30:00.000Z",
          "updated_at": "2025-01-15T10:30:00.000Z"
        }
      ]
    }
  ],
  "totalPages": 1,
  "page": 1,
  "limit": 10,
  "totalItens": 5
}