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.
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"]["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 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.list_compensations(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.expand | string | Optional | |
query.order_by | string | Optional | |
query.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
query.cursor | 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 | Model | Optional | Expand List Sites — response body — meta |
next_link | string | Optional | A link to the next page of responses. Format: uri |
results | array | Optional | |
results[] | Model | Each item | Expand List compensations — response body — results item |
Referenced models: List compensations — response body — results item, List Sites — response body — meta
Schemas
Section titled “Schemas”25 more schemas are linked from the tables above, on the schema pages.
List compensations — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
annual_compensation | object | Optional | The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
annual_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
annual_compensation.value | JSON | Optional | |
annual_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
annual_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
annual_salary_equivalent | object | Optional | The 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_type | string | Optional | The currency type, ex: USD, EUR, etc. |
annual_salary_equivalent.value | JSON | Optional | |
annual_salary_equivalent.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
annual_salary_equivalent.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
bonus_schedule | string | Optional | The worker's bonus schedule. |
created_at | string | Required within parent | Record creation date |
hourly_wage | object | Optional | The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation. |
hourly_wage.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
hourly_wage.value | JSON | Optional | |
hourly_wage.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
hourly_wage.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Identifier field |
monthly_compensation | object | Optional | The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
monthly_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
monthly_compensation.value | JSON | Optional | |
monthly_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
monthly_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
on_target_commission | object | Optional | The worker's on-target commission. |
on_target_commission.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
on_target_commission.value | JSON | Optional | |
on_target_commission.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
on_target_commission.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_terms | string | Optional | The payment terms for an worker's compensation. |
payment_type | string | Optional | The payment type for an worker's compensation. |
relocation_reimbursement | object | Optional | The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation. |
relocation_reimbursement.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
relocation_reimbursement.value | JSON | Optional | |
relocation_reimbursement.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
relocation_reimbursement.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
salary_effective_date | string | Optional | Salary effective date |
signing_bonus | object | Optional | The worker's signing bonus. |
signing_bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
signing_bonus.value | JSON | Optional | |
signing_bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
signing_bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
target_annual_bonus | object | Optional | The worker's target annual bonus amount. |
target_annual_bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
target_annual_bonus.value | JSON | Optional | |
target_annual_bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
target_annual_bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
target_annual_bonus_percent | JSON | Optional | |
target_annual_bonus_percent (anyOf 1) | number | Alternative | The worker's target annual bonus as a percent of annual compensation. |
target_annual_bonus_percent (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
weekly_compensation | object | Optional | The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
weekly_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
weekly_compensation.value | JSON | Optional | |
weekly_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
weekly_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
worker | Model | Optional | Expand Retrieve a specific compensation — response body — worker |
worker_id | string | Optional | The worker's ID. |
Referenced models: Retrieve a specific compensation — response body — worker
List Sites — response body — meta
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of redacted fields. |
redacted_fields | array | Optional | |
redacted_fields[] | object | Each item | |
redacted_fields[].name | string | Optional | The name for the redacted field |
redacted_fields[].reason | string | Optional | The reason for the redaction |
Retrieve a specific worker — response body — business partners item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_partner_group | object | Optional | Business partner group the business partner is a part of Expandable field |
business_partner_group.created_at | string | Required within parent | Record creation date |
business_partner_group.default_business_partner | Model | Optional | Expand 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_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. |
business_partner_group.domain | string | Optional | Type of business partner group Known values: HR, IT, FINANCE, RECRUITING, OTHER |
business_partner_group.id | string | Required within parent | Identifier field |
business_partner_group.name | string | Required within parent | Name used to identify business partner group |
business_partner_group.updated_at | string | Required within parent | Record update date |
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 Retrieve a specific worker — response body — manager Worker who is the business partner Expandable field |
worker_id | string | Required within parent | Identifier 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
| 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
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}