Retrieve Comment List

Request

Path Params

collection_id

string

required

Query Params

sort

string

optional

field(s) for sorting the dataset, see sorting for more info

Example:

updated_at:desc,id

limit

integer

optional

maximum number of records given, see pagination for more info

>= 1

Default:

100

Example:

50

offset

integer

optional

the number of records to be skipped, see pagination for more info

>= 0

Default:

0

Example:

0

filter

string

optional

used to filter the dataset, see filtering for more info

Example:

created_at:gt:2020-09-26,and,(id:not:starts_with:0000,or,id:contains:FFFF)

show

string

optional

limit the response to show only specific properties, see show & hide for more info

Example:

id,updated_at

hide

string

optional

hide properties from the response, see show & hide for more info

Example:

created_at,updated_at

with

array[string]

optional

object(s) included in the dataset, see eager loading for more info.

Possible options are:

collection

Allowed value:

collection

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 --request GET 'https://api.vplan.com/v1/collection//comment' \
--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