Skip to content
English
Contact Support
  • There are no suggestions because the search field is empty.

Live Ops Open API

 Live Ops Open API Access requirements

Access is controlled. The requesting system needs an API key issued specifically for live operations, a key issued for another purpose (such as timesheets) won't work here.

Authentication happens in two steps

  1. The system presents its API key.
  2. Guardhouse issues a short-lived access token.

      That token is used to request the data.

      List Live Operations

      This lets another system pull live operational data out of Guardhouse, shift and employee activity as it's happening, rather than historical timesheets. A monitoring dashboard or client system can request this data directly instead of checking the app manually.

      Every request also requires a subscription key, issued by Guardhouse Support.

      Date range

      Start and end dates are optional. If neither is provided, Guardhouse defaults to a 34-hour window centred on the current time, from 17 hours before now to 17 hours after now.

      Filtering options

      ➡️Site: by name or ID

      ➡️Customer: by name or ID

      ➡️Employee: by full name

      ➡️Subcontractor: by name

      ➡️Status: for example, Clocked In

      ➡️Search text: free-text search

      Batching

      Results come back in batches (100 by default). Each batch includes a reference point so the next or previous batch can be requested without starting over.

       

      Data returned per record

      ➡️Company, site, customer, and subcontractor names

      ➡️Employee name, mobile number, email, and address

      ➡️Scheduled start and end time, and actual clock-in and clock-out time

      ➡️Clock-in and clock-out location (latitude and longitude), and whether either was off-site

      ➡️Signature and photo capture at clock-in and clock-out

      ➡️Current status (for example, Clocked In)

      ➡️Licence details

      ➡️Welfare check responses and notifications

      ➡️Who logged the entry, and when

      ➡️Site position and shift references

       

      Error handling

      ➡️Unauthorised: the access token is missing or invalid.

      ➡️Forbidden: the token doesn't carry the required key type, or the request falls outside the API key's permissions.

      Source: https://guardhouse.mintlify.app/api-reference/live-operations/list-live-operations