Skip to main content

Get and update an Incident

GET /incidents/{id}​

Returns one Incident from the API key's organization.

  • Operation ID: get-incident
  • Success: 200 OK with the complete IncidentResponse
  • Other responses: 401 Unauthorized, 404 Not Found, 500 Internal Server Error
GET https://api.targpatrol.com/api/v1/incidents/4adbc000-3095-42f3-bddd-d8a1da1ab2bd
x-api-key: {your_external_api_key}

PATCH /incidents/{id}​

Partially updates editable Incident fields.

  • Operation ID: update-incident
  • Content-Type: application/json
  • Success: 200 OK with the updated IncidentResponse
{
  "name": "Broken lobby window - urgent",
  "priority": "CRITICAL",
  "tags": ["safety", "broken-window", "urgent"],
  "latitude": 53.9024,
  "longitude": 27.5621,
  "externalId": "FACILITY-2041",
  "clearFields": ["ASSIGNEE"]
}

You can patch name, description, typeId, categoryId, priority, locationId, pointId, assigneeId, occurredAt, tags, latitude, longitude, and externalId.

Use clearFields to remove optional values. Supported values are:

  • DESCRIPTION
  • POINT
  • ASSIGNEE
  • COORDINATES
  • EXTERNAL_ID

When setting coordinates, supply latitude and longitude together. To remove both, use COORDINATES.

stateId and clientRequestId are immutable through this endpoint. Change the state through a workflow transition.

Audit fields are server-controlled. Do not send createdBy or lastModifiedBy.

Other responses: 400 Bad Request, 401 Unauthorized, 404 Not Found, 500 Internal Server Error.