Skip to content

Rippling: GET Tiered Match 401 K

Rippling payrollApi.getTieredMatch401kId: arguments, response, policy and SDK examples.

← Payroll API operations · Get started

Operation rippling.payroll_api.get_tiered_match_401k_id

Provider route: GET /platform/api/tiered_match_401k/{id}. 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["payrollApi"]["getTieredMatch401kId"]>[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.payrollApi.getTieredMatch401kId(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.payroll_api.get_tiered_match_401k_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired 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 Tiered Match 401 K — response body

Referenced models: GET Tiered Match 401 K — response body

GET Tiered Match 401 K — response body
FieldTypePresenceDescription and constraints
$objectRootA 401K Tiered Match object. Defines the employer match scheme for 401K contributions.
einstringOptionalIf set, this tiered match will only apply to employees in this entity.
employeesarrayOptionalThe group of specified employees that this tiered match applies to. This field should be used if isDefault is set to false to define the group of employees that the tiered match applies to.
employees[]stringEach item
employerMatch401KarrayOptionalAn employer 401k match object.
employerMatch401K[]JSONEach item
employerMatch401K[] (anyOf 1)objectAlternative
employerMatch401K[] (anyOf 1).eePercentCompstringOptionalEmployee percent
employerMatch401K[] (anyOf 1).erMatchPercentstringOptionalEmployer match percentage
employerMatch401K[] (anyOf 1).tierNumJSONOptional
employerMatch401K[] (anyOf 1).tierNum (anyOf 1)integerAlternativeTier number
employerMatch401K[] (anyOf 1).tierNum (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
employerMatch401K[] (anyOf 2)nullAlternative
idstringOptionalUnique identifier of the 401K Tiered Match object.
isDefaultbooleanOptionalIf set to true, this tiered match will be applied to all employees by default unless its overridden. If set to false, it will only apply to the applicable employees.
matchingScheme401KstringRequired within parentKnown values: SAFE_HARBOR_BASIC, SAFE_HARBOR_ENHANCED, CUSTOM

SDK function policy ID: rippling.payroll_api.get_tiered_match_401k_id. Catalog operation: payroll-api.get-tiered_match_401k-id. 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.