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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.after | string | Optional | |
query.limit | integer | Optional | Format: int32 |
query.userId | integer | Optional | Format: int32 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve login activity — response body |
Referenced models: Retrieve login activity — response body
Schemas
Section titled “Schemas”Retrieve login activity — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand Retrieve login activity — response body — paging |
results | array | Required within parent | An array of PublicLoginAudit objects, each representing a single login audit event. |
results[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page. |
next | Model | Optional | Expand Retrieve login activity — response body — paging next |
Referenced models: Retrieve login activity — response body — paging next
Retrieve login activity — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
countryCode | string | Optional | The approximate country code of the login |
email | string | Optional | Email address of the user associated with the login. |
id | string | Required within parent | The login activity's unique ID. |
ipAddress | string | Optional | IP address where the activity originated. |
location | string | Optional | The approximate location where the login activity originated. |
loginAt | string | Required within parent | The time the login took place. Format: date-time |
loginSucceeded | boolean | Required within parent | Whether the login was successful or not. |
regionCode | string | Optional | The approximate region code of the login |
userAgent | string | Optional | Information about the device used for logging in. |
userId | JSON | Optional | |
userId (anyOf 1) | integer | Alternative | The user's unique ID. Format: int32 |
userId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve login activity — response body — paging next
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies the paging information needed to retrieve the next set of results in a paginated API response |
after | string | Required within parent | A string token used as a cursor to fetch the next set of results in a paged response. |
link | string | Optional | A URL string that provides a direct link to the next page of results. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]