Comments

List comments for an entity

GET /api/v1/comments

Parameters

Name	In	Type	Required	Description
`entityType`	query	string (project, space, asset, scout)	Yes	—
`entityId`	query	string	Yes	—
`limit`	query	integer	No	Maximum number of items to return.
`offset`	query	integer	No	Number of items to skip.
`search`	query	string	No	Case-insensitive search across scalar fields.
`filter`	query	string	No	Server-side exact filters as comma-separated `field=value` pairs.
`sort`	query	string	No	Comma-separated sort fields. Prefix with `-` or suffix `:desc` for descending order.
`cursor`	query	string	No	Cursor returned by a previous cursor-mode list response.
`pageMode`	query	string (offset, cursor)	No	Set to `cursor` to return `{items,nextCursor,hasMore}` inside the response data.

Example request

curl -X GET \
"https://api.getpilfer.com/api/v1/comments?entityType=<entityType>&entityId=<entityId>&limit=<limit>&offset=<offset>&search=<search>&filter=<filter>&sort=<sort>&cursor=<cursor>&pageMode=<pageMode>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [
    {
      "_id": "string",
      "entityType": "string",
      "entityId": "string",
      "body": "string",
      "parentCommentId": "string"
    }
  ]
}

Other statuses: 400, 401, 403, 404.

Response body type

{ data: Comment[] }

Create comment

POST /api/v1/comments

Example request

curl -X POST \
"https://api.getpilfer.com/api/v1/comments" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"entityType":"project","entityId":"string","body":"string","parentCommentId":"string"}'

Example response

Status: 201

{
  "data": {
    "_id": "string",
    "entityType": "string",
    "entityId": "string",
    "body": "string",
    "parentCommentId": "string"
  }
}

Other statuses: 400, 401, 403, 404.

Response body type

{ data: Comment }