Skip to content

Rippling: GET Company Activity — base Api get Company Activity

Rippling baseApi.getCompanyActivity: arguments, response, policy and SDK examples.

← Base API operations · Get started

Operation rippling.base_api.get_company_activity

Provider route: GET /platform/api/company_activity. 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["baseApi"]["getCompanyActivity"]>[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.baseApi.getCompanyActivity(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.base_api.get_company_activity(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.startDatestringOptionalFormat: date
query.endDatestringOptionalFormat: date
query.nextstringOptional
query.limitstringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
dataJSONOptional
data (anyOf 1)objectAlternative
data (anyOf 1).eventsJSONOptional
data (anyOf 1).events (anyOf 1)arrayAlternative
data (anyOf 1).events (anyOf 1)[]ModelEach itemExpand GET Company Activity — base Api get Company Activity — response body — data events, next events array item
data (anyOf 1).events (anyOf 2)nullAlternative
data (anyOf 1).nextstringOptional
data (anyOf 2)nullAlternative
errorJSONOptional
error (anyOf 1)stringAlternative
error (anyOf 2)nullAlternative

Referenced models: GET Company Activity — base Api get Company Activity — response body — data events, next events array item

GET Company Activity — base Api get Company Activity — response body — data events, next events array item
FieldTypePresenceDescription and constraints
$objectRootThe event model for company activity.

Please note, the event type can be one of the following:

- EXTERNAL_ACCONT_CREATE
- EXTERNAL_ACCOUNT_INVITE
- EXTERNAL_ACCOUNT_DELETE
- EXTERNAL_ACCOUNT_SUSPEND
- EXTERNAL_ACCOUNT_PASSWORD_RESET
- EXTERNAL_GROUP_ADD
- EXTERNAL_GROUP_REMOVE
- EXTERNAL_GROUP_MEMBER_REMOVE
- EXTERNAL_GROUP_MEMBER_ADD
- EXTERNAL_SSO_GRANT
- EXTERNAL_SSO_REVOKE
- EXTERNAL_SSO_SIGNIN
- RPASS_ITEM_SHARED
- RPASS_ITEM_UNSHARED
- RPASS_ITEM_USED
- USER_LOGIN_SUCCESS
- USER_LOGIN_FAILED
- ACCOUNT_PASSWORD_RESET
- ACCOUNT_PASSWORD_CHANGED
- TWO_FACTOR_DEVICE_RESET
companystringOptionalUnique identifier for the company.
event_reasonJSONOptional
event_reason (anyOf 1)objectAlternativeReason for the event, tied to the type of eveent.
event_reason (anyOf 1).messagestringOptionalMessage of the event.
event_reason (anyOf 1).reasonstringOptionalReason for the event.
event_reason (anyOf 2)nullAlternative
event_typestringOptionalAn ENUM value for the type of the event.
Known values: EXTERNAL_ACCOUNT_CREATE, EXTERNAL_ACCOUNT_INVITE, EXTERNAL_ACCOUNT_DELETE, EXTERNAL_ACCOUNT_SUSPEND, EXTERNAL_ACCOUNT_PASSWORD_RESET, EXTERNAL_GROUP_ADD, EXTERNAL_GROUP_REMOVE, EXTERNAL_GROUP_MEMBER_REMOVE, EXTERNAL_GROUP_MEMBER_ADD, EXTERNAL_SSO_GRANT, EXTERNAL_SSO_REVOKE, EXTERNAL_SSO_SIGNIN, EXTERNAL_SSO_SIGNIN_BLOCKED, RPASS_ITEM_SHARED, RPASS_ITEM_UNSHARED, RPASS_ITEM_USED, RPASS_FOLDER_SHARED, RPASS_FOLDER_UNSHARED, USER_LOGIN_SUCCESS, USER_LOGIN_FAILED, LDAP_AUTHENTICATION_SUCCESS, LDAP_AUTHENTICATION_FAILED, DEVICE_AUTHENTICATION_SUCCESS, DEVICE_AUTHENTICATION_FAILED, ACCOUNT_PASSWORD_RESET, ACCOUNT_PASSWORD_CHANGED, TWO_FACTOR_CHECK_SUCCESS, TWO_FACTOR_CHECK_FAILED, TWO_FACTOR_DEVICE_RESET, SPOKE_USER_MATCHED, SPOKE_USER_UNMATCHED, SECURITY_ADMINS_UPDATED, BDR_POLICY_UPDATED, AUTH_RULE_UPDATED, COMPANY_AUTH_RULE_UPDATED, ACCESS_TOKEN_EXPIRED, INBOUND_SSO_SIGN_IN, SP_INIT_SIGN_IN, EMAIL_VERIFICATION_INITIATED, PHONE_VERIFICATION_INITIATED, EMAIL_VERIFICATION_SUCCEEDED, PHONE_VERIFICATION_SUCCEEDED, EMAIL_VERIFICATION_FAILED, PHONE_VERIFICATION_FAILED, GROUP_ACCESS_CHANGED, ROLE_ATTRIBUTE_CHANGED, SCHEDULED_CHANGE_CREATED, BEHAVIOUR_DETECTION_TEST, RULE_CHANGED, ADDED_TO_INCLUSION, REMOVED_FROM_INCLUSION, ADDED_TO_POST_ROLE_STATE_INCLUSION, REMOVED_FROM_POST_ROLE_STATE_INCLUSION, ADDED_TO_TERMINATED_INCLUSION, REMOVED_FROM_TERMINATED_INCLUSION, ADDED_TO_EXCLUSION, REMOVED_FROM_EXCLUSION, EXCLUSION_RULE_CHANGED, ROLE_STATE_CHANGED, MANAGER_CHANGED, DEPARTMENT_CHANGED, LEVEL_CHANGED, ADDED_TO_TEAM, REMOVED_FROM_TEAM, JOB_UPDATED, LOCATION_CHANGED, EMPLOYMENT_TYPE_CHANGED
idstringOptionalUnique identifier of the event.
initiatorJSONOptional
initiator (anyOf 1)ModelAlternativeExpand GET Company Activity — baseApi.getCompanyActivity — response body — data / events, next / events / array / item / initiator / type: ROLE, SYSTEM, EXTERNAL
initiator (anyOf 2)nullAlternative
linked_eventsarrayOptionalAn array of event identifiers that are linked to the event.
linked_events[]stringEach item
namestringOptionalDisplay name for the event, tied to the type of event.
request_dataJSONOptional
request_data (anyOf 1)ModelAlternativeExpand GET Company Activity — base Api get Company Activity — response body — data events, next events array item request data city, country, ip, latitude, longitude
request_data (anyOf 2)nullAlternative
spokeJSONOptional
spoke (anyOf 1)stringAlternativeUnique identifier for the external application for which the event was recorded. This will be Null for events that don't correspond to an external appliction (e.g. Rippling system and RPass events).
spoke (anyOf 2)nullAlternative
subjectsarrayOptionalThe list of objects of the event.
subjects[]JSONEach item
subjects[] (anyOf 1)objectAlternative
subjects[] (anyOf 1).display_namestringOptionalName used within Rippling.
subjects[] (anyOf 1).iconJSONOptional
subjects[] (anyOf 1).icon (anyOf 1)stringAlternativeIcon used within Rippling.
subjects[] (anyOf 1).icon (anyOf 2)nullAlternative
subjects[] (anyOf 1).instancestringOptionalUnique key for the event object.
subjects[] (anyOf 1).typestringOptionalAn ENUM value for the type of object.
Known values: ROLE, SPOKE, RPASS_ITEM, SPOKE_USER, GROUP
subjects[] (anyOf 2)nullAlternative
timestampstringOptionalTimestamp at which the event was recorded.

Referenced models: GET Company Activity — baseApi.getCompanyActivity — response body — data / events, next / events / array / item / initiator / type: ROLE, SYSTEM, EXTERNAL, GET Company Activity — base Api get Company Activity — response body — data events, next events array item request data city, country, ip, latitude, longitude

GET Company Activity — baseApi.getCompanyActivity — response body — data / events, next / events / array / item / initiator / type: ROLE, SYSTEM, EXTERNAL
FieldTypePresenceDescription and constraints
$objectRootThe actor of the event.
display_namestringOptionalThe name used within Rippling.
iconJSONOptional
icon (anyOf 1)stringAlternativeThe icon used within Rippling.
icon (anyOf 2)nullAlternative
roleJSONOptional
role (anyOf 1)stringAlternativeA unique identifier for the employee that initiated the action, if the type is ROLE.
role (anyOf 2)nullAlternative
typestringOptionalENUM value for the type of actor.
Known values: ROLE, SYSTEM, EXTERNAL
GET Company Activity — base Api get Company Activity — response body — data events, next events array item request data city, country, ip, latitude, longitude
FieldTypePresenceDescription and constraints
$objectRootGeographic details from where the event was recorded.
citystringOptionalCity the event was triggered from.
countrystringOptionalCountry the event was triggered from.
ipstringOptionalEvent IP addresss.
latitudestringOptionalLatitude the event was triggered from.
longitudestringOptionalLongitude the event was triggered from.

SDK function policy ID: rippling.base_api.get_company_activity. Catalog operation: v1.get-company_activity. 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.

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.