Retrieve Comment List

Request

Path Params

collection_id

string <uuid>

required

Example:

Query Params

limit

integer

optional

Number of maximum records given. More info pagination

Default:

100

offset

integer

optional

Number of records to be skipped. More info pagination

Default:

0

filter

string

optional

Filter the dataset. More info filtering

sort

string

optional

Sorting the dataset. More info sorting

show

string

optional

Show only specific properties from the response. More info show & hide

hide

string

optional

Hide properties from the response. More info show & hide

with

string

optional

Object(s) included in the dataset. More info eager loading

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://api.vplan.com/v1/collection/{{$string.uuid}}/comment?limit=100&offset=0&filter=&sort=&show=&hide=&with=' \
--header 'x-api-key;' \
--header 'x-api-env;'

Responses

🟢200Ok

application/json

Body

count

integer <uint64>

optional

Total amount of items

>= 0

Default:

1

limit

integer <uint64>

optional

Max amount of items fetched

>= 0<= 1000

Default:

100

offset

integer <uint64>

optional

Offset so items may be paginated

>= 0

Default:

0

data

array[object (Comment) {7}]

required

Items

id

string <uuid>

read-onlyoptional

Unique identifier

text

string

optional

user_mentions

array [object {7}]

optional

collection_id

string <uuid>

required

Unique identifier of the Collection

user_id

string <uuid>

required

Unique identifier of the User

created_at

string <date-time>

read-onlyoptional

Date and time of creation

Example:

2024-04-11T10:22:15Z

updated_at

string <date-time>

read-onlyoptional

Date and time of last update

Example:

2024-04-11T10:22:15Z

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