Rippling: Retrieve a package sandbox link — response body

API reference · Contract 2026-10-28

SDK schema: Retrieve a package sandbox link — response body

Field	Type	Presence	Description and constraints
$	object	Root	Request to link a package to a sandbox, or poll an EDIT-mode installation tracker.
created_at	string	Required within parent	Record creation date
error_message	string	Optional	Error message when EDIT-mode linking failed
id	string	Required within parent	Identifier field
installation_record_id	string	Optional	Installation record ID when EDIT-mode linking completes
installation_tracker_id	string	Optional	The internal sandbox installation tracker ID
mode	string	Required within parent	How the sandbox is linked to the package (INSTALL or EDIT)
package_key	string	Required within parent	The package key to link into the sandbox
package_version_id	string	Optional	The package version being linked in EDIT mode
post_install_landing_component	object	Optional	Component to open after EDIT-mode linking completes
progress	array	Optional	EDIT-mode installation progress entries
progress[]	JSON	Each item	Additional keys: see wildcard field
progress[].*	JSON	Additional keys
sandbox_company_id	string	Required within parent	The company receiving the sandbox package installation
status	string	Optional	INSTALL completion status, or EDIT installation tracker status
updated_at	string	Required within parent	Record update date