Retrieve Comment List

GET

/collection/{collection_id}/comment

Retrieve the Comment List for this collection

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

API Key

Add parameter in header

x-api-env

Example:

x-api-env: ********************

Path Params

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.vplan.com/v1/collection//comment' \
--header 'x-api-key;' \
--header 'x-api-env;'

Responses

🟢200Ok

application/json

Body

Example

{
    "count": 1,
    "limit": 100,
    "offset": 0,
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "text": "string",
            "user_mentions": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
                    "name": "string",
                    "tag": "string",
                    "indices": [
                        0
                    ],
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                }
            ],
            "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
            "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
            "created_at": "2024-04-11T10:22:15Z",
            "updated_at": "2024-04-11T10:22:15Z"
        }
    ]
}

🟠404Not Found

🟠401Not Logged In

Modified at 2025-07-22 14:20:42

Comment

Create New Comment