Skip to main content

Incident comments

The Comment External API supports issue, task, and incident entities. Use the incident path value for Incident comments.

List comments​

  • Method: GET
  • Endpoint: /comments/by-entity-type/incident
  • Operation ID: list-comments
  • Query parameters: required relatedEntityId, plus optional limit, offset, and sort
GET https://api.targpatrol.com/api/v1/comments/by-entity-type/incident?relatedEntityId=4adbc000-3095-42f3-bddd-d8a1da1ab2bd
x-api-key: {your_external_api_key}

Create a comment​

  • Method: POST
  • Endpoint: /comments/by-entity-type/incident
  • Operation ID: create-comment
{
  "relatedEntityId": "4adbc000-3095-42f3-bddd-d8a1da1ab2bd",
  "message": "Customer has been notified.",
  "externalId": "CUSTOMER-COMMENT-42"
}

relatedEntityId is required. message is nullable and has a maximum length of 250 characters. externalId is optional.

Success returns 201 Created:

{
  "id": "38e544dc-e67a-4e7b-b92a-a88fd54775cf",
  "relatedEntityId": "4adbc000-3095-42f3-bddd-d8a1da1ab2bd",
  "message": "Customer has been notified.",
  "mediaIds": [],
  "createdAt": "2026-08-13T10:00:00.000Z",
  "createdBy": "00000000-0000-4000-8000-000000000000",
  "edited": false,
  "externalId": "CUSTOMER-COMMENT-42"
}

Comment authorship and attachments are read-only through the External API. Existing attachment IDs can be read, but attachment upload is not supported.

Update a comment​

  • Method: PATCH
  • Endpoint: /comments/{commentId}
  • Operation ID: update-comment

Only comments created through the External API can be updated.

{
  "message": "Customer has received the Incident report.",
  "externalId": "CUSTOMER-COMMENT-42"
}

Delete a comment​

  • Method: DELETE
  • Endpoint: /comments/{commentId}
  • Operation ID: delete-comment

Only comments created through the External API can be deleted. Success returns 204 No Content.

Download a Comment attachment​

  • Method: GET
  • Endpoint: /download/comments/{commentId}/media/{mediaId}/urls
  • Operation ID: get-comment-media-download-url

The media must be attached to the requested Comment in the current organization.

{
  "downloadUrl": "https://signed-download-url.example/...",
  "thumbnailDownloadUrl": null
}

Common errors are 400 Bad Request, 401 Unauthorized, 404 Not Found, and 500 Internal Server Error.