Rippling: GET Single App Referral — response body

GET Single App Referral: response body. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: GET Single App Referral — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	An app referral object as represented within Rippling.
`admin_first_name`	string	Optional	First name of the customer company admin to contact regarding this referral.
`admin_last_name`	string	Optional	Last name of the customer company admin to contact regarding this referral.
`admin_title`	string	Optional	Title of the customer company admin (in the customer company) to contact regarding this referral.
`admin_work_email`	string	Optional	Work email of the customer company admin to contact regarding this referral.
`admin_work_phone`	string	Optional	Phone number of the customer company admin to contact regarding this referral.
`app_display_name`	string	Optional	Display name of the app this app referral record is for.
`billing_address_city`	JSON	Optional
`billing_address_city (anyOf 1)`	string	Alternative	Billing address city of the customer company.
`billing_address_city (anyOf 2)`	null	Alternative
`billing_address_country`	JSON	Optional
`billing_address_country (anyOf 1)`	string	Alternative	Billing address country of the customer company.
`billing_address_country (anyOf 2)`	null	Alternative
`billing_address_line_1`	JSON	Optional
`billing_address_line_1 (anyOf 1)`	string	Alternative	Billing address line 1 of the customer company.
`billing_address_line_1 (anyOf 2)`	null	Alternative
`billing_address_line_2`	JSON	Optional
`billing_address_line_2 (anyOf 1)`	string	Alternative	Billing address line 2 of the customer company, typically floor or unit number is stored here.
`billing_address_line_2 (anyOf 2)`	null	Alternative
`billing_address_state`	JSON	Optional
`billing_address_state (anyOf 1)`	string	Alternative	Billing address state of the customer company.
`billing_address_state (anyOf 2)`	null	Alternative
`billing_address_zip_code`	JSON	Optional
`billing_address_zip_code (anyOf 1)`	string	Alternative	Billing address zip code of the customer company.
`billing_address_zip_code (anyOf 2)`	null	Alternative
`contractor_count`	JSON	Optional
`contractor_count (anyOf 1)`	integer	Alternative	Total number of active contractors in the customer company. Minimum: 0
`contractor_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`dba_name`	JSON	Optional
`dba_name (anyOf 1)`	string	Alternative	The doing business as name of the customer company.
`dba_name (anyOf 2)`	null	Alternative
`employee_count`	JSON	Optional
`employee_count (anyOf 1)`	integer	Alternative	Total number of active employees including contractors in the customer company. Minimum: 0
`employee_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`global_contractor_count`	JSON	Optional
`global_contractor_count (anyOf 1)`	integer	Alternative	Total number of active global contractors in the customer company. Global means outside of the country the customer company is primarily based out of. Minimum: 0
`global_contractor_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`global_employee_count`	JSON	Optional
`global_employee_count (anyOf 1)`	integer	Alternative	Total number of active global employees in the customer company. Global means outside of the country the customer company is primarily based out of. Minimum: 0
`global_employee_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id`	string	Optional	Rippling side id for the app referral record.
`legal_name`	string	Optional	Legal name of the customer company.
`website_url`	JSON	Optional
`website_url (anyOf 1)`	string	Alternative	Website url of the customer company.
`website_url (anyOf 2)`	null	Alternative

Report an issue with this page