Recent login activity for a user

Returns the most recent login audit events for a single user in the caller’s company. Use this for a quick “what’s this user been up to” view; use the list endpoint when you need date ranges or pagination.

Special-scope key required. This endpoint is gated by the login-audits.read entitlement. Your API key must be issued with that scope or the request will be rejected with 403 Forbidden.

Date filters are intentionally not supported here — call GET /api/external/loginaudit?userId={userId}&from=...&to=... if you need them.

GET

api

external

loginaudit

users

{userId}

recent

Recent login activity for a user

curl --request GET \
  --url https://gateway-api.guardhousehq.com/api/external/loginaudit/users/{userId}/recent \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 123,
      "userId": 123,
      "companyId": 123,
      "appType": "<string>",
      "emailAttempted": "<string>",
      "ipAddress": "<string>",
      "userAgent": "<string>",
      "failureReason": "<string>",
      "occurredUtc": "2023-11-07T05:31:56Z"
    }
  ],
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "meta": {
    "traceId": "<string>",
    "timestampUtc": "2023-11-07T05:31:56Z",
    "nextPageEndpoint": "<string>",
    "prevPageEndpoint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

userId

integer<int32>

required

The user's ID.

Query Parameters

take

integer<int32>

default:50

How many events to return. Clamped server-side to [1, 500].

Required range: 1 <= x <= 500

Response

Recent login audit events for the user, newest first.

Standard { data, errors, meta } envelope used by Login Audit endpoints. Differs from the legacy ApiResponse envelope used by older endpoints.

data

object[] · null · null

Endpoint-specific payload. null when errors is populated.

Show child attributes

errors

object[] | null

Show child attributes

meta

object

Show child attributes

List live operationsReturns live operational records for shifts and employees. Use filters such as date range, site, customer, employee name, subcontractor, and status to narrow results. If `startDate` or `endDate` is omitted, the API defaults to a 34-hour window around the current UTC time (`now - 17 hours` through `now + 17 hours`). Results support cursor-style pagination with `referenceId`, `referenceDateTime`, `direction`, and the `nextPageParameter` value returned by the previous response. Requires a public API key with `KeyType=liveops`.

Recent login activity for a user

curl --request GET \
  --url https://gateway-api.guardhousehq.com/api/external/loginaudit/users/{userId}/recent \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 123,
      "userId": 123,
      "companyId": 123,
      "appType": "<string>",
      "emailAttempted": "<string>",
      "ipAddress": "<string>",
      "userAgent": "<string>",
      "failureReason": "<string>",
      "occurredUtc": "2023-11-07T05:31:56Z"
    }
  ],
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "meta": {
    "traceId": "<string>",
    "timestampUtc": "2023-11-07T05:31:56Z",
    "nextPageEndpoint": "<string>",
    "prevPageEndpoint": "<string>"
  }
}