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>' \
  --header 'external-gh-apim-sub-key: <api-key>'

import requests

url = "https://gateway-api.guardhousehq.com/api/external/incidentreports/getall"

headers = {
    "Authorization": "Bearer <token>",
    "external-gh-apim-sub-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'external-gh-apim-sub-key': '<api-key>'}
};

fetch('https://gateway-api.guardhousehq.com/api/external/incidentreports/getall', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://gateway-api.guardhousehq.com/api/external/incidentreports/getall",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "external-gh-apim-sub-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway-api.guardhousehq.com/api/external/incidentreports/getall"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("external-gh-apim-sub-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://gateway-api.guardhousehq.com/api/external/incidentreports/getall")
  .header("Authorization", "Bearer <token>")
  .header("external-gh-apim-sub-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gateway-api.guardhousehq.com/api/external/incidentreports/getall")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["external-gh-apim-sub-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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>"
}

{
  "status": {
    "code": 123,
    "errorMessage": "<string>"
  },
  "data": "<unknown>",
  "count": 123,
  "message": "<string>",
  "errors": [
    {
      "code": 100,
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

external-gh-apim-sub-key

string

header

required

Guardhouse API Management subscription key. Required on every request. The same value is used by all API consumers within a region — contact Guardhouse Support for the subscription key.

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

List incident reports

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

import requests

url = "https://gateway-api.guardhousehq.com/api/external/incidentreports/getall"

headers = {
    "Authorization": "Bearer <token>",
    "external-gh-apim-sub-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'external-gh-apim-sub-key': '<api-key>'}
};

fetch('https://gateway-api.guardhousehq.com/api/external/incidentreports/getall', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://gateway-api.guardhousehq.com/api/external/incidentreports/getall",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "external-gh-apim-sub-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway-api.guardhousehq.com/api/external/incidentreports/getall"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("external-gh-apim-sub-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://gateway-api.guardhousehq.com/api/external/incidentreports/getall")
  .header("Authorization", "Bearer <token>")
  .header("external-gh-apim-sub-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gateway-api.guardhousehq.com/api/external/incidentreports/getall")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["external-gh-apim-sub-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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>"
}

{
  "status": {
    "code": 123,
    "errorMessage": "<string>"
  },
  "data": "<unknown>",
  "count": 123,
  "message": "<string>",
  "errors": [
    {
      "code": 100,
      "message": "<string>"
    }
  ]
}

Get started

Endpoints

List incident reports

Authorizations

Query Parameters

Response