{ "components": { "schemas": { "OutputCompanyApiBankAccounts79a4f81467f7": { "description": "A bank account object.", "properties": { "accountName": { "type": "string" }, "accountNumber": { "type": "string" }, "accountType": { "type": "string" }, "institutionName": { "type": "string" }, "routingNumber": { "type": "string" } }, "title": "BankAccounts", "type": "object" }, "OutputCompanyApiCompany1f217867f521": { "description": "A company object as represented within Rippling.", "properties": { "address": { "anyOf": [ { "description": "An address object as stored within Rippling.", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "streetLine1": { "type": "string" }, "streetLine2": { "type": "string" }, "zip": { "type": "string" } }, "title": "Address", "type": "object" }, { "type": "null" } ] }, "eins": { "items": { "type": "string" }, "type": "array" }, "entities": { "$ref": "#/components/schemas/OutputCompanyApiEntities53d83526d525" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "primaryEmail": { "type": "string" }, "subscription": { "type": "string" }, "tax_infos": { "items": { "$ref": "#/components/schemas/OutputCompanyApiTaxInformatione170fd566834" }, "type": "array" }, "workLocations": { "items": { "$ref": "#/components/schemas/OutputCompanyApiWorkLocationa3f80a0722d9" }, "type": "array" } }, "title": "Company", "type": "object" }, "OutputCompanyApiEntities53d83526d525": { "description": "This model represents the legal entities inside of a given company. Legal entities based in Canada (CA) are currently supported at this time.", "properties": { "CA": { "description": "CA represents Canada.", "items": { "properties": { "entityInfo": { "properties": { "businessNumber": { "description": "The Canada Business Number", "type": "string" }, "legalName": { "description": "The legal name of the entity", "type": "string" } }, "type": "object" }, "id": { "description": "The unique Rippling ID of the legal entity", "type": "string" }, "isEor": { "description": "If set to true, the legal entity is Rippling's EOR. If set to false, the legal entity is not on Rippling's EOR.", "type": "boolean" } }, "type": "object" }, "type": "array" } }, "title": "Entities", "type": "object" }, "OutputCompanyApiEventcb90b97cf07d": { "description": "The event model for company activity.\n\nPlease note, the event type can be one of the following:\n\n- EXTERNAL_ACCOUNT_CREATE\n- EXTERNAL_ACCOUNT_INVITE\n- EXTERNAL_ACCOUNT_DELETE\n- EXTERNAL_ACCOUNT_SUSPEND\n- EXTERNAL_ACCOUNT_PASSWORD_RESET\n- EXTERNAL_GROUP_ADD\n- EXTERNAL_GROUP_REMOVE\n- EXTERNAL_GROUP_MEMBER_REMOVE\n- EXTERNAL_GROUP_MEMBER_ADD\n- EXTERNAL_SSO_GRANT\n- EXTERNAL_SSO_REVOKE\n- EXTERNAL_SSO_SIGNIN\n- EXTERNAL_SSO_SIGNIN_BLOCKED\n- RPASS_ITEM_SHARED\n- RPASS_ITEM_UNSHARED\n- RPASS_ITEM_USED\n- RPASS_FOLDER_SHARED\n- RPASS_FOLDER_UNSHARED\n- USER_LOGIN_SUCCESS\n- USER_LOGIN_FAILED\n- LDAP_AUTHENTICATION_SUCCESS\n- LDAP_AUTHENTICATION_FAILED\n- DEVICE_AUTHENTICATION_SUCCESS\n- DEVICE_AUTHENTICATION_FAILED\n- ACCOUNT_PASSWORD_RESET\n- ACCOUNT_PASSWORD_CHANGED\n- TWO_FACTOR_CHECK_SUCCESS\n- TWO_FACTOR_CHECK_FAILED\n- TWO_FACTOR_DEVICE_RESET\n- SPOKE_USER_MATCHED\n- SPOKE_USER_UNMATCHED\n- SECURITY_ADMINS_UPDATED\n- BDR_POLICY_UPDATED\n- AUTH_RULE_UPDATED\n- COMPANY_AUTH_RULE_UPDATED\n- ACCESS_TOKEN_EXPIRED\n- INBOUND_SSO_SIGN_IN\n- SP_INIT_SIGN_IN\n- EMAIL_VERIFICATION_INITIATED\n- PHONE_VERIFICATION_INITIATED\n- EMAIL_VERIFICATION_SUCCEEDED\n- PHONE_VERIFICATION_SUCCEEDED\n- EMAIL_VERIFICATION_FAILED\n- PHONE_VERIFICATION_FAILED\n- GROUP_ACCESS_CHANGED\n- ROLE_ATTRIBUTE_CHANGED\n- SCHEDULED_CHANGE_CREATED\n- BEHAVIOUR_DETECTION_TEST\n- RULE_CHANGED\n- ADDED_TO_INCLUSION\n- REMOVED_FROM_INCLUSION\n- ADDED_TO_POST_ROLE_STATE_INCLUSION\n- REMOVED_FROM_POST_ROLE_STATE_INCLUSION\n- ADDED_TO_TERMINATED_INCLUSION\n- REMOVED_FROM_TERMINATED_INCLUSION\n- ADDED_TO_EXCLUSION\n- REMOVED_FROM_EXCLUSION\n- EXCLUSION_RULE_CHANGED\n- ROLE_STATE_CHANGED\n- MANAGER_CHANGED\n- DEPARTMENT_CHANGED\n- LEVEL_CHANGED\n- ADDED_TO_TEAM\n- REMOVED_FROM_TEAM\n- JOB_UPDATED\n- LOCATION_CHANGED\n- EMPLOYMENT_TYPE_CHANGED\n", "properties": { "company": { "description": "Unique identifier for the company.", "type": "string" }, "event_reason": { "anyOf": [ { "description": "Reason for the event, tied to the type of eveent.", "properties": { "message": { "description": "Message of the event.", "type": "string" }, "reason": { "description": "Reason for the event.", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "event_type": { "description": "An ENUM value for the type of the event.", "type": "string" }, "id": { "description": "Unique identifier of the event.", "type": "string" }, "initiator": { "anyOf": [ { "description": "The actor of the event.", "properties": { "display_name": { "description": "The name used within Rippling.", "type": "string" }, "icon": { "anyOf": [ { "description": "The icon used within Rippling.", "type": "string" }, { "type": "null" } ] }, "role": { "anyOf": [ { "description": "A unique identifier for the employee that initiated the action, if the type is ROLE.", "type": "string" }, { "type": "null" } ] }, "type": { "description": "ENUM value for the type of actor.", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "linked_events": { "description": "An array of event identifiers that are linked to the event.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Display name for the event, tied to the type of event.", "type": "string" }, "request_data": { "anyOf": [ { "description": "Geographic details from where the event was recorded.", "properties": { "city": { "description": "City the event was triggered from.", "type": "string" }, "country": { "description": "Country the event was triggered from.", "type": "string" }, "ip": { "description": "Event IP addresss.", "type": "string" }, "latitude": { "description": "Latitude the event was triggered from.", "type": "string" }, "longitude": { "description": "Longitude the event was triggered from.", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "spoke": { "anyOf": [ { "description": "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).", "type": "string" }, { "type": "null" } ] }, "subjects": { "description": "The list of objects of the event.", "items": { "anyOf": [ { "properties": { "display_name": { "description": "Name used within Rippling.", "type": "string" }, "icon": { "anyOf": [ { "description": "Icon used within Rippling.", "type": "string" }, { "type": "null" } ] }, "instance": { "description": "Unique key for the event object.", "type": "string" }, "type": { "description": "An ENUM value for the type of object.", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "type": "array" }, "timestamp": { "description": "Timestamp at which the event was recorded.", "type": "string" } }, "title": "Event", "type": "object" }, "OutputCompanyApiTaxInformatione170fd566834": { "description": "Tax information object.", "properties": { "Dba": { "type": "string" }, "ein": { "type": "string" }, "entityType": { "type": "string" }, "futaExempt": { "type": "string" }, "incorporationDate": { "type": "string" }, "incorporationState": { "type": "string" }, "nameWithIrs": { "type": "string" }, "postalAddress": { "anyOf": [ { "description": "An address object as stored within Rippling.", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "streetLine1": { "type": "string" }, "streetLine2": { "type": "string" }, "zip": { "type": "string" } }, "title": "Address", "type": "object" }, { "type": "null" } ] }, "signatory": { "type": "string" }, "soleProprieterSSN": { "type": "string" } }, "title": "TaxInformation", "type": "object" }, "OutputCompanyApiWorkLocationa3f80a0722d9": { "description": "A work location object.", "properties": { "address": { "anyOf": [ { "description": "An address object as stored within Rippling.", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "streetLine1": { "type": "string" }, "streetLine2": { "type": "string" }, "zip": { "type": "string" } }, "title": "Address", "type": "object" }, { "type": "null" } ] }, "id": { "type": "string" }, "nickname": { "type": "string" } }, "title": "WorkLocation", "type": "object" } } }, "info": { "title": "Rippling company-api", "version": "2026-10-28" }, "openapi": "3.1.0", "paths": { "/platform/api/app_detail/app_handles": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/company-api/reference/get-app-handles" }, "operationId": "rippling.company_api.get_app_handles", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "app_handle_name": { "type": "string" } }, "type": "object" } } }, "description": "OK" } }, "servers": [ { "description": "production", "url": "https://api.rippling.com" }, { "description": "sandbox", "url": "https://api.ripplingpreview.com" } ], "summary": "GET Application Handles", "x-rippling-entitlements": [], "x-rippling-required-scopes": [] } }, "/platform/api/app_detail/app_matching_users": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/company-api/reference/get-app-app-matching-users" }, "operationId": "rippling.company_api.get_app_app_matching_users", "parameters": [ { "in": "query", "name": "app_handles", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "properties": { "app_handle_id": { "properties": { "app_user_name": { "type": "string" } }, "type": "object" }, "rippling_employee_id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "OK" } }, "servers": [ { "description": "production", "url": "https://api.rippling.com" }, { "description": "sandbox", "url": "https://api.ripplingpreview.com" } ], "summary": "GET Matching App Users", "x-rippling-entitlements": [], "x-rippling-required-scopes": [] } }, "/platform/api/bank_accounts": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/company-api/reference/get-bank-accounts" }, "operationId": "rippling.company_api.get_bank_accounts", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/OutputCompanyApiBankAccounts79a4f81467f7" }, "type": "array" } } }, "description": "OK" } }, "servers": [ { "description": "production", "url": "https://api.rippling.com" }, { "description": "sandbox", "url": "https://api.ripplingpreview.com" } ], "summary": "GET Bank Accounts", "x-rippling-entitlements": [], "x-rippling-required-scopes": [] } }, "/platform/api/companies/current": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/company-api/reference/get-companies" }, "operationId": "rippling.company_api.get_companies", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputCompanyApiCompany1f217867f521" } } }, "description": "OK" } }, "servers": [ { "description": "production", "url": "https://api.rippling.com" }, { "description": "sandbox", "url": "https://api.ripplingpreview.com" } ], "summary": "GET Current Company", "x-rippling-entitlements": [], "x-rippling-required-scopes": [] } }, "/platform/api/company_activity": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/company-api/reference/get-company-activity" }, "operationId": "rippling.company_api.get_company_activity", "parameters": [ { "in": "query", "name": "startDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "endDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "anyOf": [ { "properties": { "events": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OutputCompanyApiEventcb90b97cf07d" }, "type": "array" }, { "type": "null" } ] }, "next": { "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object" } } }, "description": "OK" } }, "servers": [ { "description": "production", "url": "https://api.rippling.com" }, { "description": "sandbox", "url": "https://api.ripplingpreview.com" } ], "summary": "GET Company Activity", "x-rippling-entitlements": [], "x-rippling-required-scopes": [] } }, "/platform/api/departments": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/company-api/reference/get-departments" }, "operationId": "rippling.company_api.get_departments", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "An array of department objects.", "items": { "anyOf": [ { "description": "A company department object.", "properties": { "id": { "description": "Unique identifier of the department", "type": "string" }, "name": { "description": "Name of the department", "type": "string" }, "parent": { "anyOf": [ { "default": "null", "description": "Id of the parent department, if one exists", "type": "string" }, { "type": "null" } ] } }, "title": "Department", "type": "object" }, { "type": "null" } ] }, "type": "array" } } }, "description": "OK" } }, "servers": [ { "description": "production", "url": "https://api.rippling.com" }, { "description": "sandbox", "url": "https://api.ripplingpreview.com" } ], "summary": "GET Departments", "x-rippling-entitlements": [], "x-rippling-required-scopes": [] } } } }