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.
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["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 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.base_api.get_company_activity(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.startDate | string | Optional | Format: date |
query.endDate | string | Optional | Format: date |
query.next | string | Optional | |
query.limit | 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 | |
data | JSON | Optional | |
data (anyOf 1) | object | Alternative | |
data (anyOf 1).events | JSON | Optional | |
data (anyOf 1).events (anyOf 1) | array | Alternative | |
data (anyOf 1).events (anyOf 1)[] | Model | Each item | Expand GET Company Activity — base Api get Company Activity — response body — data events, next events array item |
data (anyOf 1).events (anyOf 2) | null | Alternative | |
data (anyOf 1).next | string | Optional | |
data (anyOf 2) | null | Alternative | |
error | JSON | Optional | |
error (anyOf 1) | string | Alternative | |
error (anyOf 2) | null | Alternative |
Referenced models: GET Company Activity — base Api get Company Activity — response body — data events, next events array item
Schemas
Section titled “Schemas”GET Company Activity — base Api get Company Activity — response body — data events, next events array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The 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 |
company | string | Optional | Unique identifier for the company. |
event_reason | JSON | Optional | |
event_reason (anyOf 1) | object | Alternative | Reason for the event, tied to the type of eveent. |
event_reason (anyOf 1).message | string | Optional | Message of the event. |
event_reason (anyOf 1).reason | string | Optional | Reason for the event. |
event_reason (anyOf 2) | null | Alternative | |
event_type | string | Optional | An 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 |
id | string | Optional | Unique identifier of the event. |
initiator | JSON | Optional | |
initiator (anyOf 1) | Model | Alternative | Expand GET Company Activity — baseApi.getCompanyActivity — response body — data / events, next / events / array / item / initiator / type: ROLE, SYSTEM, EXTERNAL |
initiator (anyOf 2) | null | Alternative | |
linked_events | array | Optional | An array of event identifiers that are linked to the event. |
linked_events[] | string | Each item | |
name | string | Optional | Display name for the event, tied to the type of event. |
request_data | JSON | Optional | |
request_data (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
spoke | JSON | Optional | |
spoke (anyOf 1) | string | Alternative | Unique 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) | null | Alternative | |
subjects | array | Optional | The list of objects of the event. |
subjects[] | JSON | Each item | |
subjects[] (anyOf 1) | object | Alternative | |
subjects[] (anyOf 1).display_name | string | Optional | Name used within Rippling. |
subjects[] (anyOf 1).icon | JSON | Optional | |
subjects[] (anyOf 1).icon (anyOf 1) | string | Alternative | Icon used within Rippling. |
subjects[] (anyOf 1).icon (anyOf 2) | null | Alternative | |
subjects[] (anyOf 1).instance | string | Optional | Unique key for the event object. |
subjects[] (anyOf 1).type | string | Optional | An ENUM value for the type of object. Known values: ROLE, SPOKE, RPASS_ITEM, SPOKE_USER, GROUP |
subjects[] (anyOf 2) | null | Alternative | |
timestamp | string | Optional | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The actor of the event. |
display_name | string | Optional | The name used within Rippling. |
icon | JSON | Optional | |
icon (anyOf 1) | string | Alternative | The icon used within Rippling. |
icon (anyOf 2) | null | Alternative | |
role | JSON | Optional | |
role (anyOf 1) | string | Alternative | A unique identifier for the employee that initiated the action, if the type is ROLE. |
role (anyOf 2) | null | Alternative | |
type | string | Optional | ENUM 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Geographic details from where the event was recorded. |
city | string | Optional | City the event was triggered from. |
country | string | Optional | Country the event was triggered from. |
ip | string | Optional | Event IP addresss. |
latitude | string | Optional | Latitude the event was triggered from. |
longitude | string | Optional | Longitude the event was triggered from. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.