Comments API Documentation
As the name suggests, comment are a core part of Pazh — the very reason Pazh exists is so you can have secure conversations with your comment'. On this page, we'll dive into the different contact endpoints you can use to manage comment programmatically. We'll look at how to query, create, update, and delete comment.
Properties
This endpoint allows you to retrieve a paginated list of all your comments. By default, a maximum of ten comments are shown per page.
- Name
id- Type
- string
- Description
identifier for the comment.
- Name
slug- Type
- string
- Description
identifier for the comment.
- Name
published- Type
- object
- Description
prepared for public.
- Name
type- Type
- string
- Description
type of the comment.
- Name
key- Type
- string
- Description
key for the comment.
- Name
parentId- Type
- string
- Description
identifier.
- Name
userId- Type
- string
- Description
identifier for the user.
- Name
fullname- Type
- string
- Description
full name of the user.
- Name
score- Type
- string
- Description
score of the comment.
- Name
like- Type
- string
- Description
like of the comment.
- Name
dislike- Type
- string
- Description
dislike of the comment.
- Name
body- Type
- string
- Description
body of the comment.
Response
{
"id": "XXXXXXXXXXXXXXXXXXXXXXX",
"slug":"",
"published": {
"type": "brand",
"key": "XXXXXXXXXXXXXXXXXXX"
},
"parentId": "",
"userId": "XXXXXXXXXXXXXXXXXXX",
"fullname": "",
"score": null, //1-5
"like": 0,
"dislike": 0,
"body": "",
"status": "deleted", //delete //spam //accept //reject
"claimed": true,
"date": "2023-02-15T12:50:30",
"authorId": ""
}
List all comments
This endpoint allows you to retrieve a paginated list of all your comments. By default, a maximum of ten comments are shown per page.
Optional attributes
- Name
limit- Type
- integer
- Description
Limit the number of comment returned.
Request
curl -G https://api.contentapi.io/v1/comment \
-H "Authorization: Bearer {token}" \
-d active=true \
-d limit=10