Skip to content

HubSpot: Retrieve login activity

HubSpot auditLogs.getLogin: arguments, response, policy and SDK examples.

← Audit logs operations · Get started

Operation hubspot.audit_logs_get_login

Provider route: GET /account-info/2026-09/activity/login. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";
async function execute(input: Parameters<HubSpotIntegration["auditLogs"]["getLogin"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.auditLogs.getLogin(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.audit_logs.get_login(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.afterstringOptional
query.limitintegerOptionalFormat: int32
query.userIdintegerOptionalFormat: int32

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve login activity — response body

Referenced models: Retrieve login activity — response body

Retrieve login activity — response body
FieldTypePresenceDescription and constraints
$objectRoot
pagingModelOptionalExpand Retrieve login activity — response body — paging
resultsarrayRequired within parentAn array of PublicLoginAudit objects, each representing a single login audit event.
results[]ModelEach itemExpand Retrieve login activity — response body — results item

Referenced models: Retrieve login activity — response body — paging, Retrieve login activity — response body — results item

Retrieve login activity — response body — paging
FieldTypePresenceDescription and constraints
$objectRootPaging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
nextModelOptionalExpand Retrieve login activity — response body — paging next

Referenced models: Retrieve login activity — response body — paging next

Retrieve login activity — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
countryCodestringOptionalThe approximate country code of the login
emailstringOptionalEmail address of the user associated with the login.
idstringRequired within parentThe login activity's unique ID.
ipAddressstringOptionalIP address where the activity originated.
locationstringOptionalThe approximate location where the login activity originated.
loginAtstringRequired within parentThe time the login took place.
Format: date-time
loginSucceededbooleanRequired within parentWhether the login was successful or not.
regionCodestringOptionalThe approximate region code of the login
userAgentstringOptionalInformation about the device used for logging in.
userIdJSONOptional
userId (anyOf 1)integerAlternativeThe user's unique ID.
Format: int32
userId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve login activity — response body — paging next
FieldTypePresenceDescription and constraints
$objectRootSpecifies the paging information needed to retrieve the next set of results in a paginated API response
afterstringRequired within parentA string token used as a cursor to fetch the next set of results in a paged response.
linkstringOptionalA URL string that provides a direct link to the next page of results.

SDK function policy ID: hubspot.audit_logs_get_login. Catalog operation: audit_logs_get_login. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["account-info.security.read"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.