Rippling: Retrieve a specific activity log event

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.get_activity_log

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

Call through Alter

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

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Format: id
query	object	Optional	Additional keys: not allowed
query.expand	string	Optional

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
$	object	Root
__meta	object	Optional
__meta.redacted_fields	array	Optional
__meta.redacted_fields[]	Model	Each item	Expand Retrieve a report run — response body — meta redacted fields item
actor_type	string	Optional	The 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_at	string	Required within parent	Record creation date
event_type	string	Optional	The open UPPER_SNAKE_CASE Activity Log code, such as USER_LOGIN_SUCCESS. New codes can appear over time.
id	string	Required within parent	Identifier field
occurred_at	string	Optional	The 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.
reason	object	Optional	Why the activity occurred. Null when no reason was recorded.
reason.code	string	Optional	The machine-readable reason code recorded for the event. Null when no reason was recorded.
reason.message	string	Optional	The human-readable meaning of the reason code. Null when no reason was recorded.
request_context	Model	Optional	Expand Retrieve a specific activity log event — response body — request context
source_app_handle	string	Optional	The public app handle used by GET /app-users/ for the Rippling app associated with the activity. Null when the activity is not app-specific.
status	string	Optional	The 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
targets	array	Optional	The resources affected by the activity. Empty when no targets were recorded.
targets[]	Model	Each item	Expand Retrieve a specific activity log event — response body — targets item
updated_at	string	Required within parent	Record update date
worker	Model	Optional	Expand Retrieve a specific activity log event — response body — worker
worker_id	string	Optional	The 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 report run — response body — meta redacted fields item, Retrieve a specific activity log event — response body — request context, Retrieve a specific activity log event — response body — worker

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.get_activity_log. Catalog operation: get-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"]

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

Official provider source