Rippling: Create hire — request body — body hires item compensation equity
Create hire: request body, field body / hires / item / compensation / equity. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Create hire — request body — body hires item compensation equity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Equity grant offered with the job. amount is the grant’s monetary value; num_shares and frequency provide additional grant terms when known. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields. Additional keys: not allowed |
amount | object | Required within parent | Monetary value assigned to the equity grant, using currency_type as a three-letter ISO 4217 code and value as the decimal amount. |
amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
amount.value | number | Optional | The decimal amount for the currency. |
frequency | string | Optional | Grant frequency when applicable: ONE_TIME or ANNUAL. One of: ONE_TIME, ANNUAL |
num_shares | integer | Optional | Number of shares or units included in the grant, when the grant is expressed in shares. |