Skip to content

Rippling: List visible activity log events retained from the last 90 days

Rippling restApi.listActivityLog: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.list_activity_log

Provider route: GET /activity-log/. Alter supplies the connection’s credentials and routing.

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

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["listActivityLog"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.restApi.listActivityLog(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.rest_api.list_activity_log(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.filterstringOptional
query.expandstringOptional
query.order_bystringOptional
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
__metaModelOptionalExpand List Sites — response body — meta
next_linkstringOptionalA link to the next page of responses.
Format: uri
resultsarrayOptional
results[]ModelEach itemExpand List visible activity log events retained from the last 90 days — response body — results item

Referenced models: List visible activity log events retained from the last 90 days — response body — results item, List Sites — response body — meta

25 more schemas are linked from the tables above, on the schema pages.

List visible activity log events retained from the last 90 days — response body — results item
FieldTypePresenceDescription and constraints
$objectRootOne visible Activity Log event retained from the last 90 days.
actor_typestringOptionalThe kind of actor that initiated the event. WORKER is a Rippling worker; INTERNAL_BY_WORKER is an internal API request triggered by a worker; SYSTEM is an automated Rippling system process; EXTERNAL is an external system or integration; RIPPLING_MDM is Rippling MDM; PARTNER is a Rippling partner, but the partner identity is not returned; and PROXY is Rippling staff or support acting through proxy. Null when no actor type was recorded.
Known values: WORKER, SYSTEM, EXTERNAL, INTERNAL_BY_WORKER, RIPPLING_MDM, PARTNER, PROXY
created_atstringRequired within parentRecord creation date
event_typestringOptionalThe open UPPER_SNAKE_CASE Activity Log code, such as USER_LOGIN_SUCCESS. New codes can appear over time.
idstringRequired within parentIdentifier field
occurred_atstringOptionalThe activity occurrence time as an ISO 8601 UTC timestamp. Unlike created_at, which records when the Activity Log record was persisted, occurred_at records when the underlying activity happened.
reasonobjectOptionalWhy the activity occurred. Null when no reason was recorded.
reason.codestringOptionalThe machine-readable reason code recorded for the event. Null when no reason was recorded.
reason.messagestringOptionalThe human-readable meaning of the reason code. Null when no reason was recorded.
request_contextModelOptionalExpand Retrieve a specific activity log event — response body — request context
source_app_handlestringOptionalThe public app handle used by GET /app-users/ for the Rippling app associated with the activity. Null when the activity is not app-specific.
statusstringOptionalThe outcome of the activity. SUCCESS means the activity completed successfully; FAILURE means the activity failed. Null when no outcome was recorded.
Known values: SUCCESS, FAILURE
targetsarrayOptionalThe resources affected by the activity. Empty when no targets were recorded.
targets[]ModelEach itemExpand Retrieve a specific activity log event — response body — targets item
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific activity log event — response body — worker
worker_idstringOptionalThe Platform worker ID from GET /workers/{id}/ when the actor is a worker. Null when the actor is not a worker.

Referenced models: Retrieve a specific activity log event — response body — targets item, Retrieve a specific activity log event — response body — request context, Retrieve a specific activity log event — response body — worker

List Sites — response body — meta
FieldTypePresenceDescription and constraints
$objectRootA list of redacted fields.
redacted_fieldsarrayOptional
redacted_fields[]objectEach item
redacted_fields[].namestringOptionalThe name for the redacted field
redacted_fields[].reasonstringOptionalThe reason for the redaction
Retrieve a specific activity log event — response body — targets item
FieldTypePresenceDescription and constraints
$objectRootA resource or internal entity affected by an Activity Log event.
idstringOptionalThe ID of the resource affected by the event. Null when the event target has no referenced resource. Filtering by targets.id is not supported for GROUP or SPOKE_USER targets.
typestringOptionalThe kind of target. WORKER uses the worker ID from GET /workers/{id}/; DEVICE uses the device ID from GET /devices/{id}/; GROUP uses the group ID from GET /supergroups/{id}/; SPOKE_USER uses the app-user ID from GET /app-users/{id}/. COMPUTER is deprecated in favor of DEVICE and its ID is not a Platform resource ID. IDs for SPOKE, RPASS_ITEM, RPASS_FOLDER, SCHEDULED_CHANGE, BDR_POLICY, AUTH_RULE, COMPANY_AUTH_RULE, USER_ACCOUNT, HARDWARE_SCRIPT, HARDWARE_CONFIGURATION, SOFTWARE_UPDATE, OS_SOFTWARE_UPDATE, WORK_EMAIL_POLICY, OFFBOARDING_POLICY, REMOTE_ACCESS_SESSION_OPTIONS, and REMOTE_ACCESS_SESSION_ERROR_DETAILS are not Platform resource IDs.
Known values: WORKER, SPOKE, RPASS_ITEM, SPOKE_USER, GROUP, RPASS_FOLDER, SCHEDULED_CHANGE, COMPUTER, BDR_POLICY, AUTH_RULE, COMPANY_AUTH_RULE, DEVICE, USER_ACCOUNT, HARDWARE_SCRIPT, HARDWARE_CONFIGURATION, SOFTWARE_UPDATE, OS_SOFTWARE_UPDATE, WORK_EMAIL_POLICY, OFFBOARDING_POLICY, REMOTE_ACCESS_SESSION_OPTIONS, REMOTE_ACCESS_SESSION_ERROR_DETAILS
Retrieve a specific activity log event — response body — request context
FieldTypePresenceDescription and constraints
$objectRootRequest and approximate location details captured for the activity. Null for non-request events.
accuracy_radiusJSONOptional
accuracy_radius (anyOf 1)numberAlternativeThe accuracy radius of the IP-derived location in kilometers. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.
accuracy_radius (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
browserstringOptionalThe browser family parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable.
citystringOptionalThe city resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.
countrystringOptionalThe country resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.
devicestringOptionalThe device family parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable.
ip_addressstringOptionalThe IPv4 or IPv6 address associated with the request. Null without the activity-log.sensitive-data.read scope.
latitudeJSONOptional
latitude (anyOf 1)numberAlternativeThe approximate latitude in decimal degrees resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.
latitude (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
longitudeJSONOptional
longitude (anyOf 1)numberAlternativeThe approximate longitude in decimal degrees resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.
longitude (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
operating_systemstringOptionalThe operating system parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable.
statestringOptionalThe state or region resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.
Retrieve a specific worker — response body — business partners item
FieldTypePresenceDescription and constraints
$objectRoot
business_partner_groupobjectOptionalBusiness partner group the business partner is a part of

Expandable field
business_partner_group.created_atstringRequired within parentRecord creation date
business_partner_group.default_business_partnerModelOptionalExpand Retrieve a specific worker — response body — manager
Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.

Expandable field
business_partner_group.default_business_partner_idstringOptionalId of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.
business_partner_group.domainstringOptionalType of business partner group
Known values: HR, IT, FINANCE, RECRUITING, OTHER
business_partner_group.idstringRequired within parentIdentifier field
business_partner_group.namestringRequired within parentName used to identify business partner group
business_partner_group.updated_atstringRequired within parentRecord update date
business_partner_group_idstringRequired within parentIdentifier of business partner group the business parter is a part of
client_groupModelOptionalExpand Create a new business partner — response body — client group
client_group_idstringOptionalIdentifier of group of workers associated with the business partner
client_group_member_countJSONOptional
client_group_member_count (anyOf 1)integerAlternativeNumber of workers associated with the business partner
client_group_member_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific worker — response body — manager
Worker who is the business partner

Expandable field
worker_idstringRequired within parentIdentifier of worker who is the business partner

Referenced models: Retrieve a specific worker — response body — manager, Create a new business partner — response body — client group

Retrieve a specific worker — response body — work schedule value
FieldTypePresenceDescription and constraints
$objectRootThe scheduled working hours for a day of the week.
hoursJSONOptional
hours (anyOf 1)numberAlternativeThe number of scheduled working hours for the day.
hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: rippling.rest_api.list_activity_log. Catalog operation: list-activity-log. 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: ["activity-log.read"]

Provider entitlements: ["Activity_Log_Platform_API", "API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

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.