Skip to content

Rippling: Company API schemas

5 Rippling schemas with complete fields and constraints.

← Company API operations · All schemas

GET Bank Accounts — response body — item

FieldTypePresenceDescription and constraints
$objectRootA bank account object.
accountNamestringOptional
accountNumberstringOptional
accountTypestringOptional
institutionNamestringOptional
routingNumberstringOptional

GET Company Activity — company 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_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
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 Current Company — company Api get Companies — response body

FieldTypePresenceDescription and constraints
$objectRootA company object as represented within Rippling.
addressJSONOptional
address (anyOf 1)objectAlternativeAn address object as stored within Rippling.
address (anyOf 1).citystringOptional
address (anyOf 1).countrystringOptional
address (anyOf 1).statestringOptional
address (anyOf 1).streetLine1stringOptional
address (anyOf 1).streetLine2stringOptional
address (anyOf 1).zipstringOptional
address (anyOf 2)nullAlternative
einsarrayOptional
eins[]stringEach item
entitiesModelOptionalExpand GET Current Company — base Api get Companies — response body — entities
idstringOptional
namestringOptional
phonestringOptional
primaryEmailstringOptional
subscriptionstringOptional
tax_infosarrayOptional
tax_infos[]ModelEach itemExpand GET Current Company — company Api get Companies — response body — tax infos item
workLocationsarrayOptional
workLocations[]ModelEach itemExpand GET Current Company — company Api get Companies — response body — work Locations item

Referenced models: GET Current Company — base Api get Companies — response body — entities, GET Current Company — company Api get Companies — response body — tax infos item, GET Current Company — company Api get Companies — response body — work Locations item

GET Current Company — company Api get Companies — response body — tax infos item

FieldTypePresenceDescription and constraints
$objectRootTax information object.
DbastringOptional
einstringOptional
entityTypestringOptional
futaExemptstringOptional
incorporationDatestringOptional
incorporationStatestringOptional
nameWithIrsstringOptional
postalAddressJSONOptional
postalAddress (anyOf 1)objectAlternativeAn address object as stored within Rippling.
postalAddress (anyOf 1).citystringOptional
postalAddress (anyOf 1).countrystringOptional
postalAddress (anyOf 1).statestringOptional
postalAddress (anyOf 1).streetLine1stringOptional
postalAddress (anyOf 1).streetLine2stringOptional
postalAddress (anyOf 1).zipstringOptional
postalAddress (anyOf 2)nullAlternative
signatorystringOptional
soleProprieterSSNstringOptional

GET Current Company — company Api get Companies — response body — work Locations item

FieldTypePresenceDescription and constraints
$objectRootA work location object.
addressJSONOptional
address (anyOf 1)objectAlternativeAn address object as stored within Rippling.
address (anyOf 1).citystringOptional
address (anyOf 1).countrystringOptional
address (anyOf 1).statestringOptional
address (anyOf 1).streetLine1stringOptional
address (anyOf 1).streetLine2stringOptional
address (anyOf 1).zipstringOptional
address (anyOf 2)nullAlternative
idstringOptional
nicknamestringOptional

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.