HubSpot: Retrieve audit logs — audit Logs get Audit Logs

← Audit logs operations · Get started

Operation hubspot.audit_logs_get_audit_logs

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

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"]["getAuditLogs"]>[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.getAuditLogs(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_audit_logs(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.actingUserId	array	Optional
query.actingUserId[]	integer	Each item	Format: int32
query.after	string	Optional
query.fillFinalTimestamp	boolean	Optional
query.limit	integer	Optional	Format: int32
query.occurredAfter	string	Optional	Format: date-time
query.occurredBefore	string	Optional	Format: date-time
query.sort	array	Optional
query.sort[]	string	Each item

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 audit logs — audit Logs get Audit Logs — response body

Referenced models: Retrieve audit logs — audit Logs get Audit Logs — response body

Schemas

Retrieve audit logs — audit Logs get Audit Logs — 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 user action events, each represented by a PublicApiUserActionEvent object.
results[]	Model	Each item	Expand Retrieve audit logs — audit Logs get Audit Logs — response body — results item

Referenced models: Retrieve login activity — response body — paging, Retrieve audit logs — audit Logs get Audit Logs — 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 audit logs — audit Logs get Audit Logs — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
actingUser	Model	Required within parent	Expand Retrieve audit logs — audit Logs get Audit Logs — response body — results item acting User
action	string	Required within parent	The type of action taken.
category	string	Required within parent	The category of the activity.
id	string	Required within parent	The login activity's unique ID.
occurredAt	string	Required within parent	The time that the action occurred at. Format: date-time
subCategory	string	Optional	The subcategory of the activity.
targetObjectId	string	Optional	The ID of the impacted object.

Referenced models: Retrieve audit logs — audit Logs get Audit Logs — response body — results item acting User

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.

Retrieve audit logs — audit Logs get Audit Logs — response body — results item acting User

Field	Type	Presence	Description and constraints
$	object	Root
userEmail	string	Optional	The email address of the user who performed the action.
userId	JSON	Required within parent
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]+)?$

Policy, approvals and errors

SDK function policy ID: hubspot.audit_logs_get_audit_logs. Catalog operation: audit_logs_get_audit_logs. 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