Rippling: Retrieve a specific business-structure-path
Rippling restApi.getBusinessStructurePaths: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.get_business_structure_paths
Provider route: GET /business-structure-paths/{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"]["getBusinessStructurePaths"]>[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.getBusinessStructurePaths(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_structure_paths(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 |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
job_codes | array | Optional | Ordered list of full JobCode objects for each job in the path, top to bottom. Populate via ?expand=job_codes. Requires both business-structure-paths.read and job-codes.read scopes. Expandable field |
job_codes[] | Model | Each item | Expand List job codes — response body — results item |
job_codes_id | array | Optional | Ordered list of Job code IDs from top to bottom. |
job_codes_id[] | string | Each item | |
name | string | Optional | Name of the path (e.g. ‘SF Office > Coffee > Barista’). |
parent | Model | Optional | Expand Create a new business-structure-path — response body — parent The parent path. Expandable field |
parent_id | string | Optional | Id of the parent BusinessStructurePath. None for root path. |
updated_at | string | Required within parent | Record update date |
Referenced models: Create a new business-structure-path — response body — parent, List job codes — response body — results item, Retrieve a report run — response body — meta redacted fields item
Schemas
Section titled “Schemas”4 more schemas are linked from the tables above, on the schema pages.
Create a new business-structure-path — 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 |
job_codes | array | Optional | Ordered list of full JobCode objects for each job in the path, top to bottom. Populate via ?expand=job_codes. Requires both business-structure-paths.read and job-codes.read scopes. Expandable field |
job_codes[] | Model | Each item | Expand List job codes — response body — results item |
job_codes_id | array | Optional | Ordered list of Job code IDs from top to bottom. |
job_codes_id[] | string | Each item | |
name | string | Optional | Name of the path (e.g. 'SF Office > Coffee > Barista'). |
parent | Model | Optional | Expand Create a new business-structure-path — response body — parent The parent path. Expandable field |
parent_id | string | Optional | Id of the parent BusinessStructurePath. None for root path. |
updated_at | string | Required within parent | Record update date |
Referenced models: Create a new business-structure-path — response body — parent, List job codes — response body — results item
List job codes — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
custom_location | Model | Optional | Expand Update a job code — response body — custom location |
department | Model | Optional | Expand Update a job code — response body — department |
department_id | string | Optional | The department associated with the job code. |
external_id | string | Optional | The unique identifier of the job code in an outside system. |
group_id | string | Optional | The ID of the job roster group. |
id | string | Required within parent | Identifier field |
is_archived | boolean | Optional | Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API. |
job_dimension | Model | Optional | Expand Update a job code — response body — job dimension |
job_dimension_id | string | Required within parent | The ID of the job dimension this job code belongs to. |
name | string | Required within parent | The name of the job dimension. |
pay_rate | JSON | Optional | |
pay_rate (anyOf 1) | number | Alternative | The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute. |
pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pay_rate_exceptions | array | Optional | Pay rate overrides for the job based on exception dimension values. Expandable field |
pay_rate_exceptions[] | Model | Each item | Expand Update a job code — response body — pay rate exceptions item |
pay_rate_exceptions_id | array | Optional | Pay rate overrides id for the job based on exception dimension values. |
pay_rate_exceptions_id[] | string | Each item | |
updated_at | string | Required within parent | Record update date |
work_location | Model | Optional | Expand Update a job code — response body — work location |
work_location_id | string | Optional | The work location associated with the job code. |
Referenced models: Update a job code — response body — pay rate exceptions item, Update a job code — response body — custom location, Update a job code — response body — department, Update a job code — response body — job dimension, Update a job code — response body — work location
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 |
Update a job code — response body — pay rate exceptions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
exception_dimension_id | string | Required within parent | Identifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource |
exception_dimension_type | string | Optional | Type of dimension on which exception is configured Known values: JOB_CODE, LEVEL, TEAM, DEPARTMENT, WORK_LOCATION |
id | string | Required within parent | Identifier field |
job_code | Model | Optional | Expand List job codes — response body — results item Job for which exception is configured. Expandable field |
job_code_id | string | Required within parent | Identifier of Job for which exception is configured. |
pay_rate | JSON | Required within parent | |
pay_rate (anyOf 1) | number | Alternative | The pay rate for exception on job_code_id and exception_dimension_id combination |
pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
Referenced models: List job codes — response body — results item
Update a job code — response body — custom location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code. |
address | Model | Required within parent | Expand Update a job code — response body — custom location address |
Referenced models: Update a job code — response body — custom location address
Update a job code — response body — department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The department associated with the job code. 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
Update a job code — response body — job dimension
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The job dimension this job code belongs to. Expandable field |
created_at | string | Required within parent | Record creation date |
external_id | string | Optional | The unique identifier of the job dimension in a third party system |
group_id | string | Optional | The ID of the dimension roster group. |
id | string | Required within parent | Identifier field |
includes_custom_location | boolean | Optional | Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true. |
name | string | Required within parent | The name of the job dimension |
org_attribute_associations | array | Optional | Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests. |
org_attribute_associations[] | JSON | Each item | Known values: DEPARTMENT, WORK_LOCATION, PAY_RATE, ENTITY |
roster_type | string | Optional | The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group. Known values: PER_DIMENSION, PER_JOB_CODE |
updated_at | string | Required within parent | Record update date |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.get_business_structure_paths. Catalog operation: get-business-structure-paths. 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-structure-paths.read"]
Provider entitlements: ["API_Tier_1"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}