Skip to content

Rippling: List compensations

Rippling restApi.listCompensations: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.list_compensations

Provider route: GET /compensations/. 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["restApi"]["listCompensations"]>[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.listCompensations(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.rest_api.list_compensations(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.expandstringOptional
query.order_bystringOptional
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
__metaModelOptionalExpand List Sites — response body — meta
next_linkstringOptionalA link to the next page of responses.
Format: uri
resultsarrayOptional
results[]ModelEach itemExpand List compensations — response body — results item

Referenced models: List compensations — response body — results item, List Sites — response body — meta

25 more schemas are linked from the tables above, on the schema pages.

List compensations — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
annual_compensationobjectOptionalThe worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.
annual_compensation.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
annual_compensation.valueJSONOptional
annual_compensation.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
annual_compensation.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
annual_salary_equivalentobjectOptionalThe worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.
annual_salary_equivalent.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
annual_salary_equivalent.valueJSONOptional
annual_salary_equivalent.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
annual_salary_equivalent.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
bonus_schedulestringOptionalThe worker's bonus schedule.
created_atstringRequired within parentRecord creation date
hourly_wageobjectOptionalThe worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.
hourly_wage.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
hourly_wage.valueJSONOptional
hourly_wage.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
hourly_wage.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentIdentifier field
monthly_compensationobjectOptionalThe worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.
monthly_compensation.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
monthly_compensation.valueJSONOptional
monthly_compensation.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
monthly_compensation.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
on_target_commissionobjectOptionalThe worker's on-target commission.
on_target_commission.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
on_target_commission.valueJSONOptional
on_target_commission.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
on_target_commission.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payment_termsstringOptionalThe payment terms for an worker's compensation.
payment_typestringOptionalThe payment type for an worker's compensation.
relocation_reimbursementobjectOptionalThe worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.
relocation_reimbursement.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
relocation_reimbursement.valueJSONOptional
relocation_reimbursement.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
relocation_reimbursement.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
salary_effective_datestringOptionalSalary effective date
signing_bonusobjectOptionalThe worker's signing bonus.
signing_bonus.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
signing_bonus.valueJSONOptional
signing_bonus.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
signing_bonus.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
target_annual_bonusobjectOptionalThe worker's target annual bonus amount.
target_annual_bonus.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
target_annual_bonus.valueJSONOptional
target_annual_bonus.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
target_annual_bonus.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
target_annual_bonus_percentJSONOptional
target_annual_bonus_percent (anyOf 1)numberAlternativeThe worker's target annual bonus as a percent of annual compensation.
target_annual_bonus_percent (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentRecord update date
weekly_compensationobjectOptionalThe worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.
weekly_compensation.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
weekly_compensation.valueJSONOptional
weekly_compensation.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
weekly_compensation.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
workerModelOptionalExpand Retrieve a specific compensation — response body — worker
worker_idstringOptionalThe worker's ID.

Referenced models: Retrieve a specific compensation — response body — worker

List Sites — response body — meta
FieldTypePresenceDescription and constraints
$objectRootA list of redacted fields.
redacted_fieldsarrayOptional
redacted_fields[]objectEach item
redacted_fields[].namestringOptionalThe name for the redacted field
redacted_fields[].reasonstringOptionalThe reason for the redaction
Retrieve a specific worker — response body — business partners item
FieldTypePresenceDescription and constraints
$objectRoot
business_partner_groupobjectOptionalBusiness partner group the business partner is a part of

Expandable field
business_partner_group.created_atstringRequired within parentRecord creation date
business_partner_group.default_business_partnerModelOptionalExpand Retrieve a specific worker — response body — manager
Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.

Expandable field
business_partner_group.default_business_partner_idstringOptionalId of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.
business_partner_group.domainstringOptionalType of business partner group
Known values: HR, IT, FINANCE, RECRUITING, OTHER
business_partner_group.idstringRequired within parentIdentifier field
business_partner_group.namestringRequired within parentName used to identify business partner group
business_partner_group.updated_atstringRequired within parentRecord update date
business_partner_group_idstringRequired within parentIdentifier of business partner group the business parter is a part of
client_groupModelOptionalExpand Create a new business partner — response body — client group
client_group_idstringOptionalIdentifier of group of workers associated with the business partner
client_group_member_countJSONOptional
client_group_member_count (anyOf 1)integerAlternativeNumber of workers associated with the business partner
client_group_member_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific worker — response body — manager
Worker who is the business partner

Expandable field
worker_idstringRequired within parentIdentifier of worker who is the business partner

Referenced models: Retrieve a specific worker — response body — manager, Create a new business partner — response body — client group

Update a team — response body — parent
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the team.
parentModelOptionalExpand Update a team — response body — parent
The parent team

Expandable field
parent_idstringOptionalThe parent team
updated_atstringRequired within parentRecord update date

Referenced models: Update a team — response body — parent

SDK function policy ID: rippling.rest_api.list_compensations. Catalog operation: list-compensations. 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: ["compensations.read"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

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.