Rippling: Retrieve a specific activity log event
Rippling restApi.getActivityLog: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.get_activity_log
Provider route: GET /activity-log/{id}/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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 osfrom alter_sdk import Appfrom 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()| 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
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 |
|---|---|---|---|
$ | 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
Schemas
Section titled “Schemas”22 more schemas are linked from the tables above, on the schema pages.
Retrieve a specific activity log event — response body — targets item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A resource or internal entity affected by an Activity Log event. |
id | string | Optional | The 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. |
type | string | Optional | The 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 report run — response body — meta redacted fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Info about the redacted fields. |
name | string | Optional | The name for the redacted field |
reason | string | Optional | The reason for the redaction |
Retrieve a specific activity log event — response body — request context
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request and approximate location details captured for the activity. Null for non-request events. |
accuracy_radius | JSON | Optional | |
accuracy_radius (anyOf 1) | number | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
browser | string | Optional | The browser family parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable. |
city | string | Optional | The city resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved. |
country | string | Optional | The country resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved. |
device | string | Optional | The device family parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable. |
ip_address | string | Optional | The IPv4 or IPv6 address associated with the request. Null without the activity-log.sensitive-data.read scope. |
latitude | JSON | Optional | |
latitude (anyOf 1) | number | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
longitude | JSON | Optional | |
longitude (anyOf 1) | number | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
operating_system | string | Optional | The operating system parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable. |
state | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_partner_group | object | Optional | Business partner group the business partner is a part of Expandable field |
business_partner_group.created_at | string | Required within parent | Record creation date |
business_partner_group.default_business_partner | Model | Optional | Expand 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_id | string | Optional | Id 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.domain | string | Optional | Type of business partner group Known values: HR, IT, FINANCE, RECRUITING, OTHER |
business_partner_group.id | string | Required within parent | Identifier field |
business_partner_group.name | string | Required within parent | Name used to identify business partner group |
business_partner_group.updated_at | string | Required within parent | Record update date |
business_partner_group_id | string | Required within parent | Identifier of business partner group the business parter is a part of |
client_group | Model | Optional | Expand Create a new business partner — response body — client group |
client_group_id | string | Optional | Identifier of group of workers associated with the business partner |
client_group_member_count | JSON | Optional | |
client_group_member_count (anyOf 1) | integer | Alternative | Number of workers associated with the business partner |
client_group_member_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific worker — response body — manager Worker who is the business partner Expandable field |
worker_id | string | Required within parent | Identifier 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
Update a team — response body — parent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the team. |
parent | Model | Optional | Expand Update a team — response body — parent The parent team Expandable field |
parent_id | string | Optional | The parent team |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a team — response body — parent
Retrieve a specific worker — response body — work schedule value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scheduled working hours for a day of the week. |
hours | JSON | Optional | |
hours (anyOf 1) | number | Alternative | The number of scheduled working hours for the day. |
hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a specific worker — response body — country fields
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Country level fields for the worker. |
ca | object | Optional | Country-wise regional fields for Canada |
ca.sin | string | Optional | Social Insurance Number (SIN) for Canada employees. |
nz | object | Optional | Country-wise regional fields for New Zealand |
nz.ird_number | string | Optional | Inland Revenue Department (IRD) number for New Zealand employees. |
us | object | Optional | Country-wise regional fields for USA |
us.ssn | string | Optional | Social Security Number (SSN) for US employees. |
Retrieve a specific worker — response body — department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker's assigned department. Expandable field |
created_at | string | Required within parent | Record creation date |
department_hierarchy | array | Optional | List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order. Expandable field |
department_hierarchy[] | Model | Each item | Expand Update a department — response body — parent |
department_hierarchy_id | array | Optional | The identifier of departments in the department hierarchy ordered from parent department to child department. |
department_hierarchy_id[] | string | Each item | |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the department. |
parent | Model | Optional | Expand Update a department — response body — parent The parent department. Expandable field |
parent_id | string | Optional | The parent department. |
reference_code | string | Optional | Reference code of the department. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a department — response body — parent
Policy, approvals and errors
Section titled “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", "API_Tier_1"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}