GET /api/v2/assets/:asset_id/comments
Get comments for asset

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

GET /api/v2/assets/8I2vT3wBW4fR4Me2PnyH/comments
200
{
  "comments": []
}
GET /api/v2/assets/not-found-id/comments
404
{
  "error": "asset not found"
}

Params

Param name Description
asset_id
required

Asset ID

Validations:

  • Must be a String

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

POST /api/v2/assets/:asset_id/comments
Create comment for asset

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

POST /api/v2/assets/9I2vT3wBW4fR4Me2UHxI/comments
{
  "comment": "Sample comment"
}
200
{
  "comment": {
    "id": 3,
    "user_id": 259,
    "asset_id": "9I2vT3wBW4fR4Me2UHxI",
    "event_type": "commented asset",
    "message": "Sample comment",
    "created_at": "2021-10-05T09:01:03.715Z",
    "updated_at": "2021-10-05T09:01:03.715Z",
    "email": null
  }
}

Params

Param name Description
asset_id
required

Asset ID

Validations:

  • Must be a String

comment
required

Comment

Validations:

  • Must be a String

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

GET /api/v2/projects/:project_id/comments
Get comments for project

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

GET /api/v2/projects/942vT3wBW4fR4Me2Wnz4/comments
200
{
  "comments": []
}
GET /api/v2/projects/not-found-id/comments
404
{
  "error": "project not found"
}

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

POST /api/v2/projects/:project_id/comments
Create comment for project

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

POST /api/v2/projects/-42vT3wBW4fR4Me2a3ys/comments
{
  "comment": "Sample comment"
}
200
{
  "comment": {
    "id": 4,
    "user_id": 262,
    "asset_id": "-42vT3wBW4fR4Me2a3ys",
    "event_type": "commented asset",
    "message": "Sample comment",
    "created_at": "2021-10-05T09:01:10.084Z",
    "updated_at": "2021-10-05T09:01:10.084Z",
    "email": null
  }
}

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String

comment
required

Comment

Validations:

  • Must be a String

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY