List incident reports

GET

api

external

incidentreports

getall

List incident reports

curl --request GET \
  --url https://gateway-api.guardhousehq.com/api/external/incidentreports/getall \
  --header 'Authorization: Bearer <token>'

{
  "status": {
    "code": 123,
    "errorMessage": "<string>"
  },
  "data": [
    {
      "incidentReportId": 123,
      "companyName": "<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>",
      "staffId": 123,
      "staffName": "<string>",
      "licenseNumber": "<string>",
      "reportName": "<string>",
      "reportId": "<string>",
      "submittedBy": 123,
      "submittedByName": "<string>",
      "submittedDate": "2023-11-07T05:31:56Z",
      "isApproved": true,
      "isEnableToShowInCustomerPortal": true,
      "status": "<string>",
      "isActionRequired": true,
      "pdfLink": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "modifiedBy": 123,
      "modifiedByName": "<string>",
      "modifiedDate": "2023-11-07T05:31:56Z",
      "previousIncidentReportId": 123,
      "isModified": true,
      "longitude": 123,
      "latitude": 123,
      "geoStampAccuracy": 123
    }
  ],
  "count": 123,
  "message": "<string>",
  "errors": [
    {
      "code": 100,
      "message": "<string>"
    }
  ],
  "recordCount": 123,
  "totalRecordCount": 123,
  "prevPageEndpoint": "<string>",
  "prevPageParams": "<string>",
  "nextPageEndpoint": "<string>",
  "nextPageParams": "<string>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

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.

referenceId

integer<int32>

Cursor anchor ID. Pass the last incidentReportId (or equivalent) you saw to fetch the next page.

referenceName

string

Cursor anchor name when paginating across results sorted by name.

referenceDateTime

string<date-time>

Cursor anchor timestamp when paginating across time-sorted results.

startDate

string<date-time>

Inclusive start of the date filter (UTC).

endDate

string<date-time>

Inclusive end of the date filter (UTC).

searchText

string

Free-text filter applied across name and identifier columns.

limit

integer<int32>

default:100

Maximum number of records to return.

direction

enum<string>

default:next

Cursor pagination direction. Use next to page forward and prev to page back.

Available options:

next,

prev

isApproved

boolean

default:false

When true, return only approved reports.

formName

string

Filter by form template name.

reportId

string

Filter by the human-facing report ID.

Response

Paginated list of incident reports

Envelope for paginated list endpoints. The cursor is encoded in nextPageParams / prevPageParams.

status

object

Show child attributes

data

object[]

Endpoint-specific payload. null when an error occurred.

Show child attributes

count

integer<int32> | null

message

string

errors

object[]

Show child attributes

recordCount

integer<int32> | null

totalRecordCount

integer<int32> | null

prevPageEndpoint

string | null

prevPageParams

string | null

nextPageEndpoint

string | null

nextPageParams

string | null

Get full incident report detailReturns the full report including every question, answer, and attachment metadata for a single incident report.

List incident reports

curl --request GET \
  --url https://gateway-api.guardhousehq.com/api/external/incidentreports/getall \
  --header 'Authorization: Bearer <token>'

{
  "status": {
    "code": 123,
    "errorMessage": "<string>"
  },
  "data": [
    {
      "incidentReportId": 123,
      "companyName": "<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>",
      "staffId": 123,
      "staffName": "<string>",
      "licenseNumber": "<string>",
      "reportName": "<string>",
      "reportId": "<string>",
      "submittedBy": 123,
      "submittedByName": "<string>",
      "submittedDate": "2023-11-07T05:31:56Z",
      "isApproved": true,
      "isEnableToShowInCustomerPortal": true,
      "status": "<string>",
      "isActionRequired": true,
      "pdfLink": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "modifiedBy": 123,
      "modifiedByName": "<string>",
      "modifiedDate": "2023-11-07T05:31:56Z",
      "previousIncidentReportId": 123,
      "isModified": true,
      "longitude": 123,
      "latitude": 123,
      "geoStampAccuracy": 123
    }
  ],
  "count": 123,
  "message": "<string>",
  "errors": [
    {
      "code": 100,
      "message": "<string>"
    }
  ],
  "recordCount": 123,
  "totalRecordCount": 123,
  "prevPageEndpoint": "<string>",
  "prevPageParams": "<string>",
  "nextPageEndpoint": "<string>",
  "nextPageParams": "<string>"
}