List login audit events

Returns login audit events for the caller’s company, newest first.

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. Contact Guardhouse Support to have the scope added to an existing key.

Tenant scope: the company is taken from your access token’s CompanyId claim. Passing companyId in the query string is ignored — cross-tenant isolation is enforced server-side.

Results are ordered by occurredUtc descending and paged with Skip((page - 1) * pageSize).Take(pageSize). There is no totalCount field — when fewer than pageSize rows are returned, you have reached the end.

GET

api

external

loginaudit

List login audit events

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

import requests

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

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

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

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

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

{
  "data": "<unknown>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "meta": {
    "traceId": "<string>",
    "timestampUtc": "2023-11-07T05:31:56Z",
    "nextPageEndpoint": "<string>",
    "prevPageEndpoint": "<string>"
  }
}

{
  "data": "<unknown>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "meta": {
    "traceId": "<string>",
    "timestampUtc": "2023-11-07T05:31:56Z",
    "nextPageEndpoint": "<string>",
    "prevPageEndpoint": "<string>"
  }
}

{
  "data": "<unknown>",
  "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/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

userId

integer<int32>

Filter to a specific user.

eventType

enum<integer>

Filter by event type. 1 = LoginSuccess, 2 = LoginFailure, 3 = Logout (reserved).

Available options:

1,

2,

3

from

string<date-time>

Inclusive lower bound on occurredUtc (ISO-8601 UTC, e.g. 2026-04-01T00:00:00Z).

string<date-time>

Inclusive upper bound on occurredUtc (ISO-8601 UTC).

page

integer<int32>

default:1

1-based page index. Must be >= 1.

Required range: x >= 1

pageSize

integer<int32>

default:50

Page size. Must be between 1 and 500.

Required range: 1 <= x <= 500

Response

Paged list of login audit events.

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 login audit events

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

import requests

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

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

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

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

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

{
  "data": "<unknown>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "meta": {
    "traceId": "<string>",
    "timestampUtc": "2023-11-07T05:31:56Z",
    "nextPageEndpoint": "<string>",
    "prevPageEndpoint": "<string>"
  }
}

{
  "data": "<unknown>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "meta": {
    "traceId": "<string>",
    "timestampUtc": "2023-11-07T05:31:56Z",
    "nextPageEndpoint": "<string>",
    "prevPageEndpoint": "<string>"
  }
}

{
  "data": "<unknown>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "meta": {
    "traceId": "<string>",
    "timestampUtc": "2023-11-07T05:31:56Z",
    "nextPageEndpoint": "<string>",
    "prevPageEndpoint": "<string>"
  }
}

Get started

Endpoints

List login audit events

Authorizations

Query Parameters

Response