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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.appReferralId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand GET Single App Referral — response body |
Referenced models: GET Single App Referral — response body
Schemas
Section titled “Schemas”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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.