For AI agents: an index of this documentation is at https://developer.rippling.com/llms.txt. Public pages have a Markdown version at the same URL with .md added.

Skip to main content
REST API
Article

BreakPolicy

Use with AI:Rippling AI ChatGPT Claude Cursor

BreakPolicy

    id stringrequired

    Identifier field

    created_at stringrequired

    Record creation date

    updated_at stringrequired

    Record update date

    name stringrequired

    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.

    country_code string

    ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').

    is_default boolean

    Whether this is a system-seeded default policy (true) or a custom policy created by an admin (false).