Rippling: Retrieve a specific business partner
Rippling restApi.getBusinessPartners: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.get_business_partners
Provider route: GET /business-partners/{id}/. 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["restApi"]["getBusinessPartners"]>[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.restApi.getBusinessPartners(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.rest_api.get_business_partners(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.id | string | Required within parent | Format: id |
query | object | Optional | Additional keys: not allowed |
query.expand | string | Optional |
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 |
|---|---|---|---|
$ | object | Root | |
__meta | object | Optional | |
__meta.redacted_fields | array | Optional | |
__meta.redacted_fields[] | Model | Each item | Expand Retrieve a report run — response body — meta redacted fields item |
business_partner_group | Model | Optional | Expand Create a new business partner — response body — business partner group |
business_partner_group_id | string | Required within parent | Identifier of business partner group the business parter is a part of |
client_group | Model | Optional | Expand Create a new business partner — response body — client group |
client_group_id | string | Optional | Identifier of group of workers associated with the business partner |
client_group_member_count | JSON | Optional | |
client_group_member_count (anyOf 1) | integer | Alternative | Number of workers associated with the business partner |
client_group_member_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Create a new business partner — response body — worker |
worker_id | string | Required within parent | Identifier of worker who is the business partner |
Referenced models: Retrieve a report run — response body — meta redacted fields item, Create a new business partner — response body — business partner group, Create a new business partner — response body — client group, Create a new business partner — response body — worker
Schemas
Section titled “Schemas”22 more schemas are linked from the tables above, on the schema pages.
Retrieve a report run — response body — meta redacted fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Info about the redacted fields. |
name | string | Optional | The name for the redacted field |
reason | string | Optional | The reason for the redaction |
Create a new business partner — response body — business partner group
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Business partner group the business partner is a part of Expandable field |
created_at | string | Required within parent | Record creation date |
default_business_partner | Model | Optional | Expand Create a new business partner — response body — business partner group default business partner |
default_business_partner_id | string | Optional | Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group. |
domain | string | Optional | Type of business partner group Known values: HR, IT, FINANCE, RECRUITING, OTHER |
id | string | Required within parent | Identifier field |
name | string | Required within parent | Name used to identify business partner group |
updated_at | string | Required within parent | Record update date |
Referenced models: Create a new business partner — response body — business partner group default business partner
Create a new business partner — response body — client group
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Group of workers associated with the business partner Expandable field |
allow_non_employees | boolean | Optional | Whether the group allows non employees |
app_owner_id | string | Optional | The id of the group's app owner. |
can_override_role_states | boolean | Optional | Whether the group can override role states |
created_at | string | Required within parent | Record creation date |
cumulatively_exhaustive_default | boolean | Optional | Whether the group is the cumulatively exhaustive default |
description | string | Optional | The group's description. |
display_name | string | Optional | The group's display name. |
group_type | string | Optional | The group type |
id | string | Required within parent | Identifier field |
ignore_prov_group_matching | boolean | Optional | Whether to ignore provisioning group matching when determining group membership |
include_terminated | boolean | Optional | Whether the group include terminated roles |
is_invisible | boolean | Optional | Whether the group is invisible |
mutually_exclusive_key | string | Optional | The group's mutually exclusive key |
name | string | Optional | The group's name. |
parent | string | Optional | The group's parent. |
priority | JSON | Optional | |
priority (anyOf 1) | integer | Alternative | The group's priority when calculating mutual exclusivity |
priority (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
read_only | boolean | Optional | Whether the group is read only. |
sub_group_type | string | Optional | The sub group type |
updated_at | string | Required within parent | Record update date |
List business partners — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_partner_group | Model | Optional | Expand Create a new business partner — response body — business partner group |
business_partner_group_id | string | Required within parent | Identifier of business partner group the business parter is a part of |
client_group | Model | Optional | Expand Create a new business partner — response body — client group |
client_group_id | string | Optional | Identifier of group of workers associated with the business partner |
client_group_member_count | JSON | Optional | |
client_group_member_count (anyOf 1) | integer | Alternative | Number of workers associated with the business partner |
client_group_member_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Create a new business partner — response body — worker |
worker_id | string | Required within parent | Identifier of worker who is the business partner |
Referenced models: Create a new business partner — response body — business partner group, Create a new business partner — response body — client group, Create a new business partner — response body — worker
Update a team — response body — parent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the team. |
parent | Model | Optional | Expand Update a team — response body — parent The parent team Expandable field |
parent_id | string | Optional | The parent team |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a team — response body — parent
Retrieve a specific worker — response body — work schedule value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scheduled working hours for a day of the week. |
hours | JSON | Optional | |
hours (anyOf 1) | number | Alternative | The number of scheduled working hours for the day. |
hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a specific worker — response body — country fields
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Country level fields for the worker. |
ca | object | Optional | Country-wise regional fields for Canada |
ca.sin | string | Optional | Social Insurance Number (SIN) for Canada employees. |
nz | object | Optional | Country-wise regional fields for New Zealand |
nz.ird_number | string | Optional | Inland Revenue Department (IRD) number for New Zealand employees. |
us | object | Optional | Country-wise regional fields for USA |
us.ssn | string | Optional | Social Security Number (SSN) for US employees. |
Retrieve a specific worker — response body — department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker's assigned department. Expandable field |
created_at | string | Required within parent | Record creation date |
department_hierarchy | array | Optional | List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order. Expandable field |
department_hierarchy[] | Model | Each item | Expand Update a department — response body — parent |
department_hierarchy_id | array | Optional | The identifier of departments in the department hierarchy ordered from parent department to child department. |
department_hierarchy_id[] | string | Each item | |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the department. |
parent | Model | Optional | Expand Update a department — response body — parent The parent department. Expandable field |
parent_id | string | Optional | The parent department. |
reference_code | string | Optional | Reference code of the department. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a department — response body — parent
Retrieve a specific legal entity — response body — country
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The country the legal entity is based in. |
code | string | Required within parent | The code of the country. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.get_business_partners. Catalog operation: get-business-partners. 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.
Required provider scopes: ["business-partners.read"]
Provider entitlements: ["API_Tier_1"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}