Retrieve Single Comment

Request

Path Params

collection_id

string

required

comment_id

string

required

Query Params

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

id

string <uuid>

read-onlyoptional

Unique identifier

text

string

optional

user_mentions

array [object {7}]

optional

id

string <uuid>

required

user_id

string <uuid>

required

name

string

required

tag

string

required

indices

array[integer]

required

created_at

string <date-time>

required

updated_at

string <date-time>

required

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

{
  "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