Rippling: Retrieve a specific break type — response body — policy
Retrieve a specific break type: response body, field policy. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Retrieve a specific break type — response body — policy
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The break policy this break type belongs to. Use ?expand=policy to inline the full policy object. Expandable field |
country_code | string | Optional | ISO 3166-1 alpha-2 country code the policy applies to (e.g. ‘US’, ‘CA’, ‘GB’). |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_default | boolean | Optional | Whether this is a system-seeded default policy (true) or a custom policy created by an admin (false). |
name | string | Required within parent | The display name of the break policy. For default policies this is the system-generated label (e.g. ‘Default Break policy: All Workers | California’); for custom policies this is the admin-provided description. |
updated_at | string | Required within parent | Record update date |