> ## Documentation Index
> Fetch the complete documentation index at: https://support.visualcare.com.au/llms.txt
> Use this file to discover all available pages before exploring further.

# Incidents

> SIRS and general incident records

<Note>
  This page documents the API endpoints for retrieving incident data programmatically. If you need to view, edit, or report on an individual incident record in vCore, for example when preparing evidence for the NDIS Commission, see [Editing incidents](/incidents/editing-incidents) and the [SIRS register](/incidents/sirs-register) instead.
</Note>

### GET /incidents

**Example:** `GET /incidents?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&limit=100`

**Query parameters:**

| Parameter        | Default | Description                                              |
| ---------------- | ------- | -------------------------------------------------------- |
| `limit`          | 200     | Items per page                                           |
| `fromDate`       | -       | Incidents with NoteDate >= value. Format: `YYYY-MM-DD`   |
| `toDate`         | -       | Incidents with NoteDate \<= value. Format: `YYYY-MM-DD`  |
| `createfromDate` | -       | Incidents with Timestamp >= value. Format: `YYYY-MM-DD`  |
| `createtoDate`   | -       | Incidents with Timestamp \<= value. Format: `YYYY-MM-DD` |
| `clientId`       | -       | Filter by client ID (maps to `_ReferringId_1`)           |
| `assignedTo`     | -       | Filter by assigned user                                  |
| `closed`         | -       | Filter by closed status (`true`/`false`)                 |
| `taskClosed`     | -       | Filter by task closed status (`true`/`false`)            |
| `InclForm`       | -       | If set, returns data from the Incident form              |

**Response fields:**

| Field              | Type        | Notes                     |
| ------------------ | ----------- | ------------------------- |
| `IncidentId`       | integer     |                           |
| `CategoryId`       | integer     |                           |
| `IncidentType`     | string      | for example `"CLIENT"`    |
| `Note`             | string      |                           |
| `Reason`           | string      |                           |
| `Comment`          | string      |                           |
| `Action`           | string      |                           |
| `Outcome`          | string      |                           |
| `Response`         | null/string |                           |
| `Location`         | string      |                           |
| `Occurrence`       | string      |                           |
| `Performance`      | string      |                           |
| `NoteDate`         | string      | Datetime                  |
| `NotifiedDate`     | string      | Datetime                  |
| `AlertDate`        | string      | Datetime                  |
| `CloseDate`        | string      | Datetime                  |
| `TaskClosedDate`   | string      | Datetime                  |
| `IsReportable`     | integer     | 0/1                       |
| `Reported24Hour`   | integer     | 0/1                       |
| `Reported5Day`     | integer     | 0/1                       |
| `AssignedTo`       | string      | Email                     |
| `AssignedToSecond` | string      |                           |
| `Closed`           | integer     | 0/1                       |
| `TaskClosed`       | integer     | 0/1                       |
| `RequiresFollowUp` | integer     | 0/1                       |
| `VisibleClientApp` | integer     | 0/1                       |
| `VisibleWorkerApp` | integer     | 0/1                       |
| `CreatedBy`        | string      | Email                     |
| `DataSource`       | string      | for example `"Incidents"` |
| `IncidentCode`     | string      |                           |
| `Timestamp`        | string      | Datetime                  |
| `_ReferringId_1`   | integer     | Client ID                 |
| `_ReferringId_2`   | integer     |                           |
| `_ReferringId_3`   | integer     |                           |

**Form** (when `InclForm` is set): Nested `FormData` array with `answers` objects containing `name`, `text`, `type`, `order`, `answer` fields.

***

### GET /SIRS

Serious Incident Response Scheme incidents.

**Example:** `GET /SIRS?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&limit=100`

**Query parameters:**

| Parameter        | Default | Description                                            |
| ---------------- | ------- | ------------------------------------------------------ |
| `limit`          | 200     | Items per page                                         |
| `fromDate`       | -       | SIRS with IncidentDate >= value. Format: `YYYY-MM-DD`  |
| `toDate`         | -       | SIRS with IncidentDate \<= value. Format: `YYYY-MM-DD` |
| `createDateFrom` | -       | SIRS with Timestamp >= value. Format: `YYYY-MM-DD`     |
| `createDateTo`   | -       | SIRS with Timestamp \<= value. Format: `YYYY-MM-DD`    |
| `clientId`       | -       | Filter by client ID (maps to `_ReferringId_1`)         |
| `assignedTo`     | -       | Filter by assigned user                                |
| `closed`         | -       | Filter by closed status (`true`/`false`)               |
| `taskClosed`     | -       | Filter by task closed status (`true`/`false`)          |

**Response fields:**

| Field              | Type        | Notes    |
| ------------------ | ----------- | -------- |
| `IncidentId`       | integer     |          |
| `CategoryId`       | integer     |          |
| `Note`             | string      |          |
| `Reason`           | string      |          |
| `Comment`          | string      |          |
| `Action`           | string      |          |
| `Outcome`          | string      |          |
| `Response`         | null/string |          |
| `Location`         | string      |          |
| `Occurrence`       | string      |          |
| `Performance`      | string      |          |
| `NoteDate`         | string      | Datetime |
| `NotifiedDate`     | string      | Datetime |
| `AlertDate`        | string      | Datetime |
| `CloseDate`        | string      | Datetime |
| `TaskClosedDate`   | string      | Datetime |
| `AssignedTo`       | string      |          |
| `AssignedToSecond` | string      |          |
| `Closed`           | integer     | 0/1      |
| `TaskClosed`       | integer     | 0/1      |
| `RequiresFollowUp` | integer     | 0/1      |
| `VisibleClientApp` | integer     | 0/1      |
| `VisibleWorkerApp` | integer     | 0/1      |
| `CreatedBy`        | string      | Email    |