Learn more about the account activity API endpoints.
GET
request to /account-info/v3/activity/audit-logs
. You can include the following query parameters to filter the results:
actingUserId
: retrieve user-specific logs by specifying a user ID.occurredAfter
: retrieve logs starting from a specific timestamp.occurredBefore
: retrieve logs up until a specific timestamp.Parameter | Type | Description |
---|---|---|
id | String | The unique ID of the action event. |
category | String | The type of user action. |
subCategory | String | The subcategory of user action. |
action | String | The action performed. |
targetObjectId | String | The ID of the object that the user performed the action on. |
occurredAt | String | The timestamp of when the action was performed. |
actingUser | Object | An object containing the user’s ID and email address. |
GET
request to /account-info/v3/activity/login
. You can retrieve user-specific login history by including the userId
query parameter followed by the user ID.
The response will include an object for each login attempt (successful and unsuccessful) made in the past 90 days, including login attempts to app.hubspot.com and the HubSpot mobile app.
Parameter | Type | Description |
---|---|---|
id | String | The unique ID of the login event. |
loginAt | String | The timestamp of when login was attempted. |
userId | Integer | The ID of the user associated with the activity. |
email | String | The email address of the user associated with the activity. |
loginSucceeded | Boolean | Whether the login attempt was successful. |
ipAddress | String | The IP address used for the login attempt. |
location | String | The location where the login was attempted. |
userAgent | String | User agent information about the device used for login. |
countryCode | String | The country code of the location where the login was attempted. |
regionCode | String | The region code of the location where the login was attempted. |
GET
request to /account-info/v3/activity/security
. You can include the following query parameters to filter the results:
userId
: retrieve user-specific history by specifying a user ID.fromTimestamp
: retrieve history starting from a specific datetime.toTimestamp
: retrieve history up until a specific datetime.Parameter | Type | Description |
---|---|---|
id | String | The unique ID of the login event. |
createdAt | String | The timestamp of when activity occurred. |
userId | Integer | The ID of the user associated with the activity. |
type | String | The type of activity. |
actingUser | String | The email address of the user associated with the activity. |
objectId | String | The ID of the object that the activity was performed on. |
infoUrl | String | The URL of the page where the activity occurred. |
location | String | The location where the login was attempted. |
ipAddress | String | The IP address used for the login attempt. |
userAgent | String | User agent information about the device used for login. |
countryCode | String | The country code of the location where the login was attempted. |
regionCode | String | The region code of the location where the login was attempted. |