Get comments list

get https://{domain}.uspacy.ua/comments/v1/comments

Lists the comments related to some entity. nextId and prevId fields in response help to do pagination. For more information see the description of nextId and prevId fields in the response.

Query Params

entity_type

string

Entity type name. If it's comment, record represents the child comment and entityId represents the parent comment ID. And only the child comments are being sent in this case. Use along with childList and lastId to paginate the child comments.

entityId

int64

required

Entity ID

list

number

Defaults to 20

Use this to define the number of top level comments to retrieve. Retrieve all if missing or retrieve the rest if nextId is present.

childList

int32

Defaults to 2

Use this to define the number of child comments to retrieve. Retrieve all if missing or retrieve the rest if lastId is present.

nextId

int64

The top level comments are being paginated starting from the last page but in the ascending order. This parameter used to point the topmost comment on the previous page. For example: to get the previous page in the sample below nextId must be 22.

comment-22
comment-23
comment-24

and the entire query should look like the following:

?entityType=post&entityId=123&list=3&childList=2&nextId=22

This means: to get the previous 3 comments of the entity post-123 along with the possible child comments (no more then 2 child comments per parent) relating to the comment-22

lastId

int64

This parameter used to point the bottom child comment on the previous page. For example: to get the next page if the child comments in the sample below, lastId must be 27, entityType must be "comment" and entityId must be 25.

comment-23
comment-24
comment-25
child-comment-26-of-parent-25
child-comment-27-of-parent-25

and the entire query should look like the following:

?entityType=post&entityId=123&childList=2&entityType=comment&entityId=25&lastId=27

This means: to get the next 2 child comments of parent comment-25 of the entity post-123 relating to the child-comment-27

Responses

401

Access token is missing or invalid

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://domain.uspacy.ua/comments/v1/comments?list=20&childList=2' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response