Skip to content

Rippling: GET Single App Referral

Rippling developerPortal.getAppReferralsAppReferralId: arguments, response, policy and SDK examples.

← Developer portal operations · Get started

Operation rippling.developer_portal.get_app_referrals_appreferralid

Provider route: GET /platform/api/app_referrals/{appReferralId}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["developerPortal"]["getAppReferralsAppReferralId"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.developerPortal.getAppReferralsAppReferralId(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.developer_portal.get_app_referrals_app_referral_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.appReferralIdstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand GET Single App Referral — response body

Referenced models: GET Single App Referral — response body

GET Single App Referral — response body
FieldTypePresenceDescription and constraints
$objectRootAn app referral object as represented within Rippling.
admin_first_namestringOptionalFirst name of the customer company admin to contact regarding this referral.
admin_last_namestringOptionalLast name of the customer company admin to contact regarding this referral.
admin_titlestringOptionalTitle of the customer company admin (in the customer company) to contact regarding this referral.
admin_work_emailstringOptionalWork email of the customer company admin to contact regarding this referral.
admin_work_phonestringOptionalPhone number of the customer company admin to contact regarding this referral.
app_display_namestringOptionalDisplay name of the app this app referral record is for.
billing_address_cityJSONOptional
billing_address_city (anyOf 1)stringAlternativeBilling address city of the customer company.
billing_address_city (anyOf 2)nullAlternative
billing_address_countryJSONOptional
billing_address_country (anyOf 1)stringAlternativeBilling address country of the customer company.
billing_address_country (anyOf 2)nullAlternative
billing_address_line_1JSONOptional
billing_address_line_1 (anyOf 1)stringAlternativeBilling address line 1 of the customer company.
billing_address_line_1 (anyOf 2)nullAlternative
billing_address_line_2JSONOptional
billing_address_line_2 (anyOf 1)stringAlternativeBilling address line 2 of the customer company, typically floor or unit number is stored here.
billing_address_line_2 (anyOf 2)nullAlternative
billing_address_stateJSONOptional
billing_address_state (anyOf 1)stringAlternativeBilling address state of the customer company.
billing_address_state (anyOf 2)nullAlternative
billing_address_zip_codeJSONOptional
billing_address_zip_code (anyOf 1)stringAlternativeBilling address zip code of the customer company.
billing_address_zip_code (anyOf 2)nullAlternative
contractor_countJSONOptional
contractor_count (anyOf 1)integerAlternativeTotal number of active contractors in the customer company.
Minimum: 0
contractor_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dba_nameJSONOptional
dba_name (anyOf 1)stringAlternativeThe doing business as name of the customer company.
dba_name (anyOf 2)nullAlternative
employee_countJSONOptional
employee_count (anyOf 1)integerAlternativeTotal number of active employees including contractors in the customer company.
Minimum: 0
employee_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
global_contractor_countJSONOptional
global_contractor_count (anyOf 1)integerAlternativeTotal 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
global_employee_countJSONOptional
global_employee_count (anyOf 1)integerAlternativeTotal 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringOptionalRippling side id for the app referral record.
legal_namestringOptionalLegal name of the customer company.
website_urlJSONOptional
website_url (anyOf 1)stringAlternativeWebsite url of the customer company.
website_url (anyOf 2)nullAlternative

SDK function policy ID: rippling.developer_portal.get_app_referrals_appreferralid. Catalog operation: developer-portal.get-app_referrals-appReferralId. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

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.