Skip to content

Rippling: contract 2026-10-28

What changed after Rippling contract 2026-10-28, and the packages that pin it.

Contract 2026-10-28 is a retired Rippling contract. Alter still runs it for installed SDKs, the current SDK’s kept methods and pending approvals that pin it. Its full operation reference is not published: the API reference documents the current contract, 2026-11-07. See all contracts.

The last release that pins this contract is version 0.4.3: @alter-ai/rippling 0.4.3 on npm and alter-sdk-rippling 0.4.3 on PyPI. Each package page documents that release.

The provider’s native API description of this contract, as Alter published it: rippling.base-api.2026-10-28.openapi.json, rippling.company-api.2026-10-28.openapi.json, rippling.developer-portal.2026-10-28.openapi.json, rippling.employee-api.2026-10-28.openapi.json, rippling.global-payroll-api.2026-10-28.openapi.json, rippling.job-board-api-v2.2026-10-28.openapi.json, rippling.payroll-api.2026-10-28.openapi.json, rippling.recruiting-api.2026-10-28.openapi.json, rippling.reports-api.2026-10-28.openapi.json, rippling.rest-api.2026-10-28.openapi.json, rippling.t-and-a-api.2026-10-28.openapi.json, rippling.v1-archive-api.2026-10-28.openapi.json.

The current packages keep 6 deprecated methods whose operations a later contract dropped. Each still calls this contract, so code written against an earlier package keeps working after an upgrade; the API reference documents each one, marked deprecated.

OperationTypeScriptPython
rippling.rest_api.get_bill_paymentsrestApi.getBillPaymentsrest_api.get_bill_payments
rippling.rest_api.get_spend_categoriesrestApi.getSpendCategoriesrest_api.get_spend_categories
rippling.rest_api.get_spend_vendorsrestApi.getSpendVendorsrest_api.get_spend_vendors
rippling.rest_api.list_bill_paymentsrestApi.listBillPaymentsrest_api.list_bill_payments
rippling.rest_api.list_spend_categoriesrestApi.listSpendCategoriesrest_api.list_spend_categories
rippling.rest_api.list_spend_vendorsrestApi.listSpendVendorsrest_api.list_spend_vendors

This contract has 480 operations. Contract 2026-11-07 added 17, removed 6 and changed 44.

Operation links open the current contract’s reference (2026-11-07).

OperationTypeScriptPython
rippling.rest_api.capabilities_custom_object_list_viewrestApi.capabilitiesCustomObjectListViewrest_api.capabilities_custom_object_list_view
rippling.rest_api.create_custom_object_list_viewrestApi.createCustomObjectListViewrest_api.create_custom_object_list_view
rippling.rest_api.create_package_version_from_manifestrestApi.createPackageVersionFromManifestrest_api.create_package_version_from_manifest
rippling.rest_api.default_custom_object_list_viewrestApi.defaultCustomObjectListViewrest_api.default_custom_object_list_view
rippling.rest_api.delete_functionsrestApi.deleteFunctionsrest_api.delete_functions
rippling.rest_api.destroy_custom_object_list_viewrestApi.destroyCustomObjectListViewrest_api.destroy_custom_object_list_view
rippling.rest_api.extract_package_componentsrestApi.extractPackageComponentsrest_api.extract_package_components
rippling.rest_api.get_billsrestApi.getBillsrest_api.get_bills
rippling.rest_api.get_finance_categoriesrestApi.getFinanceCategoriesrest_api.get_finance_categories
rippling.rest_api.get_finance_vendorsrestApi.getFinanceVendorsrest_api.get_finance_vendors
rippling.rest_api.get_package_version_manifestrestApi.getPackageVersionManifestrest_api.get_package_version_manifest
rippling.rest_api.list_billsrestApi.listBillsrest_api.list_bills
rippling.rest_api.list_finance_categoriesrestApi.listFinanceCategoriesrest_api.list_finance_categories
rippling.rest_api.list_finance_vendorsrestApi.listFinanceVendorsrest_api.list_finance_vendors
rippling.rest_api.list_package_component_typesrestApi.listPackageComponentTypesrest_api.list_package_component_types
rippling.rest_api.list_package_componentsrestApi.listPackageComponentsrest_api.list_package_components
rippling.rest_api.partial_update_custom_object_list_viewrestApi.partialUpdateCustomObjectListViewrest_api.partial_update_custom_object_list_view
OperationTypeScriptPython
rippling.rest_api.get_bill_paymentsrestApi.getBillPaymentsrest_api.get_bill_payments
rippling.rest_api.get_spend_categoriesrestApi.getSpendCategoriesrest_api.get_spend_categories
rippling.rest_api.get_spend_vendorsrestApi.getSpendVendorsrest_api.get_spend_vendors
rippling.rest_api.list_bill_paymentsrestApi.listBillPaymentsrest_api.list_bill_payments
rippling.rest_api.list_spend_categoriesrestApi.listSpendCategoriesrest_api.list_spend_categories
rippling.rest_api.list_spend_vendorsrestApi.listSpendVendorsrest_api.list_spend_vendors
OperationTypeScriptPythonWhat changed
rippling.rest_api.append_agent_session_messagerestApi.appendAgentSessionMessagerest_api.append_agent_session_messageresponse
rippling.rest_api.create_agent_sessionrestApi.createAgentSessionrest_api.create_agent_sessionresponse
rippling.rest_api.create_draft_transitionsrestApi.createDraftTransitionsrest_api.create_draft_transitionsrequest, response
rippling.rest_api.create_employee_documentsrestApi.createEmployeeDocumentsrest_api.create_employee_documentsrequest, response
rippling.rest_api.create_functionsrestApi.createFunctionsrest_api.create_functionsrequest, response
rippling.rest_api.create_hiresrestApi.createHiresrest_api.create_hiresrequest
rippling.rest_api.create_next_package_versionsrestApi.createNextPackageVersionsrest_api.create_next_package_versionsresponse
rippling.rest_api.create_package_versionsrestApi.createPackageVersionsrest_api.create_package_versionsresponse
rippling.rest_api.create_sandboxesrestApi.createSandboxesrest_api.create_sandboxesrequest, response
rippling.rest_api.create_sitesrestApi.createSitesrest_api.create_sitesprovider entitlements
rippling.rest_api.delete_sitesrestApi.deleteSitesrest_api.delete_sitesprovider entitlements
rippling.rest_api.file_operations_sitesrestApi.fileOperationsSitesrest_api.file_operations_sitesprovider entitlements
rippling.rest_api.files_sitesrestApi.filesSitesrest_api.files_sitesprovider entitlements
rippling.rest_api.get_activity_logrestApi.getActivityLogrest_api.get_activity_logprovider entitlements
rippling.rest_api.get_agent_sessionrestApi.getAgentSessionrest_api.get_agent_sessionresponse
rippling.rest_api.get_card_transactionsrestApi.getCardTransactionsrest_api.get_card_transactionsprovider entitlements, request, response
rippling.rest_api.get_custom_object_list_viewrestApi.getCustomObjectListViewrest_api.get_custom_object_list_viewendpoint, request, response
rippling.rest_api.get_devicesrestApi.getDevicesrest_api.get_devicesresponse
rippling.rest_api.get_draft_transitionsrestApi.getDraftTransitionsrest_api.get_draft_transitionsresponse
rippling.rest_api.get_functionsrestApi.getFunctionsrest_api.get_functionsresponse
rippling.rest_api.get_package_installsrestApi.getPackageInstallsrest_api.get_package_installsresponse
rippling.rest_api.get_package_managed_installsrestApi.getPackageManagedInstallsrest_api.get_package_managed_installsresponse
rippling.rest_api.get_package_versionsrestApi.getPackageVersionsrest_api.get_package_versionsresponse
rippling.rest_api.get_reimbursementsrestApi.getReimbursementsrest_api.get_reimbursementsprovider entitlements, request, response
rippling.rest_api.get_sandboxesrestApi.getSandboxesrest_api.get_sandboxesresponse
rippling.rest_api.get_sitesrestApi.getSitesrest_api.get_sitesprovider entitlements
rippling.rest_api.install_package_installsrestApi.installPackageInstallsrest_api.install_package_installsrequest, response
rippling.rest_api.install_package_managed_installsrestApi.installPackageManagedInstallsrest_api.install_package_managed_installsrequest, response
rippling.rest_api.list_activity_logrestApi.listActivityLogrest_api.list_activity_logprovider entitlements
rippling.rest_api.list_agent_sessionsrestApi.listAgentSessionsrest_api.list_agent_sessionsresponse
rippling.rest_api.list_by_query_custom_objects_custom_object_api_name_recordsrestApi.listByQueryCustomObjectsCustomObjectApiNameRecordsrest_api.list_by_query_custom_objects_custom_object_api_name_recordsrequest
rippling.rest_api.list_card_transactionsrestApi.listCardTransactionsrest_api.list_card_transactionsprovider entitlements, request, response
rippling.rest_api.list_custom_object_list_viewsrestApi.listCustomObjectListViewsrest_api.list_custom_object_list_viewsresponse
rippling.rest_api.list_devicesrestApi.listDevicesrest_api.list_devicesresponse
rippling.rest_api.list_functionsrestApi.listFunctionsrest_api.list_functionsresponse
rippling.rest_api.list_package_versionsrestApi.listPackageVersionsrest_api.list_package_versionsresponse
rippling.rest_api.list_reimbursementsrestApi.listReimbursementsrest_api.list_reimbursementsprovider entitlements, request, response
rippling.rest_api.list_sandboxesrestApi.listSandboxesrest_api.list_sandboxesresponse
rippling.rest_api.list_sitesrestApi.listSitesrest_api.list_sitesprovider entitlements
rippling.rest_api.publish_package_versionsrestApi.publishPackageVersionsrest_api.publish_package_versionsresponse
rippling.rest_api.update_functionsrestApi.updateFunctionsrest_api.update_functionsrequest, response
rippling.rest_api.update_package_versionsrestApi.updatePackageVersionsrest_api.update_package_versionsrequest, response
rippling.rest_api.update_sitesrestApi.updateSitesrest_api.update_sitesprovider entitlements
rippling.rest_api.upload_batches_presign_sitesrestApi.uploadBatchesPresignSitesrest_api.upload_batches_presign_sitesprovider entitlements

Breaking changes in the 2026-11-07 packages

Section titled “Breaking changes in the 2026-11-07 packages”

Rippling changed these operations upstream, and the current packages follow the provider: code written against the 0.4.3 packages may need a change on upgrading. Each was reviewed when the contract was adopted.

Python methodKindWhat changedWhy
rest_api.create_draft_transitionsInputbody.items[].changes.employment_info.annual_salary_equivalent: type number -> object
body.items[].changes.employment_info.equity_value: type number -> object
body.items[].changes.employment_info.on_target_commission: type number -> object
body.items[].changes.employment_info.relocation_reimbursement: type number -> object
body.items[].changes.employment_info.salary_per_unit: type number -> object
body.items[].changes.employment_info.target_annual_bonus: type number -> object
Rippling now takes each compensation amount as a currency object (`value`, `currency_type`) instead of a bare number.
rest_api.create_sandboxesInputbody.type: enum imposedRippling documents `developer` as the only supported sandbox type.
rest_api.get_custom_object_list_viewInputpath.id: no longer accepted
path.view_api_name: newly required
Rippling now addresses a list view by its `api_name`; the view’s `id` is a read-only internal identifier with a different value, so an `id` sent as the name would retrieve the wrong view or none.
rest_api.update_package_versionsInputbody: additional properties no longer acceptedRippling now documents `description` and `post_install_function` as the only fields a package-version update takes (at least one of them); `description` is no longer required.
rest_api.create_draft_transitionsResponseitems[].changes.employment_info.annual_salary_equivalent: type number/string -> object
items[].changes.employment_info.equity_value: type number/string -> object
items[].changes.employment_info.on_target_commission: type number/string -> object
items[].changes.employment_info.relocation_reimbursement: type number/string -> object
items[].changes.employment_info.salary_per_unit: type number/string -> object
items[].changes.employment_info.target_annual_bonus: type number/string -> object
Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it.
rest_api.create_sandboxesResponseconfig_override: no longer returnedRippling’s 2026-11-07 reference no longer documents the removed response fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it.
rest_api.get_card_transactionsResponseattachments[]: type string -> object
receipt: type string -> object
Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it.
rest_api.get_custom_object_list_viewResponsecolumns[].width: no longer returnedRippling’s 2026-11-07 reference no longer documents the removed response fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it.
rest_api.get_draft_transitionsResponseitems[].changes.employment_info.annual_salary_equivalent: type number/string -> object
items[].changes.employment_info.equity_value: type number/string -> object
items[].changes.employment_info.on_target_commission: type number/string -> object
items[].changes.employment_info.relocation_reimbursement: type number/string -> object
items[].changes.employment_info.salary_per_unit: type number/string -> object
items[].changes.employment_info.target_annual_bonus: type number/string -> object
Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it.
rest_api.get_reimbursementsResponseattachments[]: type string -> object
receipt: type string -> object
Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it.
rest_api.get_sandboxesResponseconfig_override: no longer returnedRippling’s 2026-11-07 reference no longer documents the removed response fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it.
rest_api.list_card_transactionsResponseresults[].attachments[]: type string -> object
results[].receipt: type string -> object
Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it.
rest_api.list_custom_object_list_viewsResponseresults[].columns[].width: no longer returnedRippling’s 2026-11-07 reference no longer documents the removed response fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it.
rest_api.list_reimbursementsResponseresults[].attachments[]: type string -> object
results[].receipt: type string -> object
Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it.
rest_api.list_sandboxesResponseresults[].config_override: no longer returnedRippling’s 2026-11-07 reference no longer documents the removed response fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it.
rest_api.create_sitesRequestentitlements: added API_Tier_1
entitlements: removed Sites_Platform_API
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.delete_sitesRequestentitlements: added API_Tier_1
entitlements: removed Sites_Platform_API
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.file_operations_sitesRequestentitlements: added API_Tier_1
entitlements: removed Sites_Platform_API
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.files_sitesRequestentitlements: added API_Tier_1
entitlements: removed Sites_Platform_API
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.get_activity_logRequestentitlements: added API_Tier_1Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.get_card_transactionsRequestentitlements: added Spend_Management_Platform_API
entitlements: removed Internal_Testing
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.get_custom_object_list_viewRequestpath: "/custom-objects/{custom_object_api_name}/list-views/{id}/" -> "/custom-objects/{custom_object_api_name}/list-views/{view_api_name}/"Rippling’s 2026-11-07 reference addresses a list view by its `view_api_name` instead of its read-only internal `id` (the matching input change is recorded under reviewed_input_changes and changelogged).
rest_api.get_reimbursementsRequestentitlements: added Spend_Management_Platform_API
entitlements: removed Internal_Testing
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.get_sitesRequestentitlements: added API_Tier_1
entitlements: removed Sites_Platform_API
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.list_activity_logRequestentitlements: added API_Tier_1Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.list_card_transactionsRequestentitlements: added Spend_Management_Platform_API
entitlements: removed Internal_Testing
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.list_reimbursementsRequestentitlements: added Spend_Management_Platform_API
entitlements: removed Internal_Testing
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.list_sitesRequestentitlements: added API_Tier_1
entitlements: removed Sites_Platform_API
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.update_sitesRequestentitlements: added API_Tier_1
entitlements: removed Sites_Platform_API
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.
rest_api.upload_batches_presign_sitesRequestentitlements: added API_Tier_1
entitlements: removed Sites_Platform_API
Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists.

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.