Skip to main content
GET
/
api
/
external
/
incidentreports
/
reportdata
Get full incident report detail
curl --request GET \
  --url https://gateway-api.guardhousehq.com/api/external/incidentreports/reportdata \
  --header 'Authorization: Bearer <token>'
{
  "status": {
    "code": 123,
    "errorMessage": "<string>"
  },
  "data": {
    "incidentReportId": 123,
    "formName": "<string>",
    "customerName": "<string>",
    "customerApiReferenceNumber": "<string>",
    "siteType": "<string>",
    "siteName": "<string>",
    "siteAddress": "<string>",
    "siteCity": "<string>",
    "siteState": "<string>",
    "siteCountry": "<string>",
    "sitePostCode": "<string>",
    "siteApiReferenceNumber": "<string>",
    "patrolSiteName": "<string>",
    "patrolSiteAddress": "<string>",
    "patrolSiteCity": "<string>",
    "patrolSiteState": "<string>",
    "patrolSiteCountry": "<string>",
    "patrolSitePostCode": "<string>",
    "patrolSiteApiReferenceNumber": "<string>",
    "staffName": "<string>",
    "licenseNumber": "<string>",
    "reportId": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "submittedByName": "<string>",
    "submittedDate": "2023-11-07T05:31:56Z",
    "modifiedByName": "<string>",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "previousIncidentReportId": 123,
    "incidentReportDetail": [
      {
        "incidentReportDetailId": 123,
        "parentIncidentReportDetailAnswerId": 123,
        "parentIncidentReportDetailId": 123,
        "setNumber": 123,
        "isNeedAction": true,
        "actionDescription": "<string>",
        "incidentReportQuestion": {},
        "incidentReportDetailAnswers": [
          {}
        ]
      }
    ]
  },
  "count": 123,
  "message": "<string>",
  "errors": [
    {
      "code": 100,
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT issued by POST /api/token/request. Send as Authorization: Bearer <token>.

Query Parameters

​
incidentReportId
integer<int32>
required

The incident report's numeric ID.

​
customerId
string

Semicolon-separated list of customer IDs. Defaults to the customers your API key is scoped to.

​
siteId
string

Semicolon-separated list of site IDs. Defaults to the sites your API key is scoped to.

​
companyId
string

Company ID. Normally derived from your API key claims; only set this if you have multi-company access.

Response

Incident report detail

The standard envelope for every JSON endpoint.

​
status
object
​
data
object

Full report including the report-level summary and every question/answer.

​
count
integer<int32> | null
​
message
string
​
errors
object[]