Rippling: Company API schemas
5 Rippling schemas with complete fields and constraints.
← Company API operations · All schemas
GET Bank Accounts — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A bank account object. |
accountName | string | Optional | |
accountNumber | string | Optional | |
accountType | string | Optional | |
institutionName | string | Optional | |
routingNumber | string | Optional |
GET Company Activity — company 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_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 |
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 Current Company — company Api get Companies — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A company object as represented within Rippling. |
address | JSON | Optional | |
address (anyOf 1) | object | Alternative | An address object as stored within Rippling. |
address (anyOf 1).city | string | Optional | |
address (anyOf 1).country | string | Optional | |
address (anyOf 1).state | string | Optional | |
address (anyOf 1).streetLine1 | string | Optional | |
address (anyOf 1).streetLine2 | string | Optional | |
address (anyOf 1).zip | string | Optional | |
address (anyOf 2) | null | Alternative | |
eins | array | Optional | |
eins[] | string | Each item | |
entities | Model | Optional | Expand GET Current Company — base Api get Companies — response body — entities |
id | string | Optional | |
name | string | Optional | |
phone | string | Optional | |
primaryEmail | string | Optional | |
subscription | string | Optional | |
tax_infos | array | Optional | |
tax_infos[] | Model | Each item | Expand GET Current Company — company Api get Companies — response body — tax infos item |
workLocations | array | Optional | |
workLocations[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Tax information object. |
Dba | string | Optional | |
ein | string | Optional | |
entityType | string | Optional | |
futaExempt | string | Optional | |
incorporationDate | string | Optional | |
incorporationState | string | Optional | |
nameWithIrs | string | Optional | |
postalAddress | JSON | Optional | |
postalAddress (anyOf 1) | object | Alternative | An address object as stored within Rippling. |
postalAddress (anyOf 1).city | string | Optional | |
postalAddress (anyOf 1).country | string | Optional | |
postalAddress (anyOf 1).state | string | Optional | |
postalAddress (anyOf 1).streetLine1 | string | Optional | |
postalAddress (anyOf 1).streetLine2 | string | Optional | |
postalAddress (anyOf 1).zip | string | Optional | |
postalAddress (anyOf 2) | null | Alternative | |
signatory | string | Optional | |
soleProprieterSSN | string | Optional |
GET Current Company — company Api get Companies — response body — work Locations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A work location object. |
address | JSON | Optional | |
address (anyOf 1) | object | Alternative | An address object as stored within Rippling. |
address (anyOf 1).city | string | Optional | |
address (anyOf 1).country | string | Optional | |
address (anyOf 1).state | string | Optional | |
address (anyOf 1).streetLine1 | string | Optional | |
address (anyOf 1).streetLine2 | string | Optional | |
address (anyOf 1).zip | string | Optional | |
address (anyOf 2) | null | Alternative | |
id | string | Optional | |
nickname | string | Optional |