List sites

GET

api

external

sites

List sites

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

import requests

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

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/sites', 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/sites",
  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/sites"

	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/sites")
  .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/sites")

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": [
    {
      "id": 123,
      "name": "<string>",
      "customerId": 123,
      "customer": "<string>",
      "siteReferenceNumber1": "<string>",
      "siteReferenceNumber2": "<string>",
      "siteAPIReferenceField": "<string>",
      "referenceId": "<string>",
      "address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>"
    }
  ],
  "count": 123,
  "message": "<string>",
  "errors": [
    {
      "code": 100,
      "message": "<string>"
    }
  ],
  "nextPageParameter": "<string>",
  "prevPageParameter": "<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

integer<int32>

Filter to sites belonging to a specific customer. Omit to fall back to the customers your API key is scoped to.

filter

string

Free-text filter across site name and identifier columns.

isActive

boolean

default:true

When true (default), only return active sites.

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.

limit

integer<int32>

default:20

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

Response

Paginated list of sites

Envelope for the newer cursor-paginated endpoints (timesheets, staff, customers, sites). The cursor is encoded as a string in nextPageParameter / prevPageParameter and is intended to be POSTed back as the next request body — or appended to the query string verbatim.

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

nextPageParameter

string | null

prevPageParameter

string | null

List sites

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

import requests

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

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/sites', 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/sites",
  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/sites"

	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/sites")
  .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/sites")

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": [
    {
      "id": 123,
      "name": "<string>",
      "customerId": 123,
      "customer": "<string>",
      "siteReferenceNumber1": "<string>",
      "siteReferenceNumber2": "<string>",
      "siteAPIReferenceField": "<string>",
      "referenceId": "<string>",
      "address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>"
    }
  ],
  "count": 123,
  "message": "<string>",
  "errors": [
    {
      "code": 100,
      "message": "<string>"
    }
  ],
  "nextPageParameter": "<string>",
  "prevPageParameter": "<string>"
}

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

Get started

Endpoints

Authorizations

Query Parameters

Response