> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Rippling

> How to set up the Rippling connector, plus the actions that are available.

![Rippling](https://stackone-logos.com/api/rippling/filled/svg)

Previewv1.2.0[See changelog](https://docs.stackone.com/connectors/rippling/changelog.md)

[365 actions](#actions) · 1 auth method

HRIS
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Token · Connector Profile](https://docs.stackone.com/connectors/rippling/guides/connector-profile/api-token.md)
>
> Connect your Rippling account using an API token from the API Tokens app in Rippling

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Token · Link Account](https://docs.stackone.com/connectors/rippling/guides/link-account/api-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

activity-log.read

agent-deployments.read

agent-deployments.read-write

agent-sessions.read

agent-sessions.read-write

agent-source-revisions.read

agent-source-revisions.read-write

agents.read

agents.read-write

app-users.read

background-check-candidates.read

background-check-candidates.read-write

background-check-invitations.read

background-check-invitations.read-write

background-check-nodes.read

background-check-nodes.read-write

background-check-orders.read

background-check-orders.read-write

background-check-packages.read

background-check-packages.read-write

background-check-reports.read

background-check-reports.read-write

bills.read

bills.read-write

break-policies.read

break-types.read

business-partner-groups.read

business-partner-groups.read-write

business-partners.read

business-partners.read-write

business-structure-paths.read

business-structure-paths.read-write

candidate-applications.read

candidates.read

card-transactions.read

card-transactions.read-write

companies.read

company-legal-entities.read

company-legal-entity-workers.read

compensation-bands-details.read

compensations.read

custom-apps.read

custom-apps.read-write

custom-fields.read

custom-object-records.read

custom-object-records.read-write

custom-objects.read

custom-objects.read-write

custom-objects.read-write.owner

custom-pages.read

custom-pages.read-write

custom-settings.read

custom-settings.read-write

departments.read

departments.read-write

device-orders.read

devices.read

draft-hires.read-write

draft-transitions.read

draft-transitions.read-write

earning-types.read

earnings-inputs.read

earnings-inputs.read-write

employee-documents.read-write

employment-types.read

entitlements.read

files.read

files.read-write

finance-categories.read

finance-vendors.read

function-executions.read

function-executions.read-write

functions.read

functions.read-write

headcount-positions.read

headcount-priorities.read

hire-requirements.read

hires.read-write

job-assignments.read

job-assignments.read-write

job-codes.read

job-codes.read-write

job-dimensions.read

job-dimensions.read-write

job-functions.read

job-pay-rate-exceptions.read

job-requisitions-write.read-write

job-requisitions.read

kiosk-badges.read

kiosk-badges.read-write

leave-accruals.read

leave-accruals.read-write

leave-balances.read

leave-requests.read

leave-requests.read-write

leave-types.read

legal-entities.read

levels.read

levels.read-write

location-factors.read

metadata.read

metadata.read-write

payroll-runs.read

permission-profiles.read

platform-capabilities.read

reimbursements.read

reimbursements.read-write

report-runs.read

report-runs.read-write

reports.read

scheduled-job-assignments.read

scheduled-job-assignments.read-write

scheduled-payouts.read

scheduled-payouts.read-write

schedules.read

schedules.read-write

shift-inputs.read

shift-inputs.read-write

shiftassignments.read

shiftassignments.read-write

sites.read

sites.read-write

software-deployments.read

software-deployments.read-write

sso-me.read

supergroups.read

supergroups.read-write

teams.read-write

time-cards.read

time-entries.read

time-entries.read-write

titles.read

titles.read-write

tracks.read

tracks.read-write

unassignedshifts.read

unassignedshifts.read-write

users.read

variable-compensation-payout-labels.read

variable-compensation-payout-labels.read-write

variable-compensation-payout-types.read

variable-compensation-payout-types.read-write

variable-compensation-payouts.read

variable-compensation-payouts.read-write

work-locations.read-write

worker-change-fields.read

worker-changes.read

worker-payroll-records.read

worker-time-splits.read

worker-time-splits.read-write

workers.read

workflow-action-executions.read-write

workflow-executions.read

workflow-executions.read-write

workflows.read

workflows.read-write

No scopes found

365 actions

ActionDescriptionRequired scopes

List Activity Log`rippling_list_activity_log`

Lists only Activity Log events retained from the last 90 days that are visible to the caller

`activity-log.read`

Retrieve A Specific Activity Log`rippling_get_activity_log`

Retrieves one Activity Log event from the same 90-day visibility set as the list endpoint

`activity-log.read`

List Agent Deployments`rippling_list_agent_deployments`

Returns a paginated list of deployments for an agent

`agent-deployments.read`

List Agent Session Events`rippling_list_agent_session_events`

List events for an agent session after an optional sequence number

`agent-sessions.read`

List Agent Sessions`rippling_list_agent_sessions`

Returns a paginated list of sessions for an agent

`agent-sessions.read`

List Agent Source Revisions`rippling_list_agent_source_revisions`

Returns a paginated list of source revisions for an agent

`agent-source-revisions.read`

List Agents`rippling_list_agents`

List locally created agents and company-installed global agents

`agents.read`

Retrieve A Specific Agent Deployment`rippling_get_agent_deployment`

Retrieve a deployment for an agent

`agent-deployments.read`

Retrieve An Agent Session`rippling_get_agent_session`

Retrieve an agent session, including its terminal output or error when available

`agent-sessions.read`

Retrieve An Agent Source Revision`rippling_get_agent_source_revision`

Retrieve a source revision for an agent

`agent-source-revisions.read`

Retrieve A Specific Agent`rippling_get_agent`

Retrieve a locally created agent or a company-installed global agent

`agents.read`

Create A New Agent Deployment`rippling_create_agent_deployment`

Deploy a source revision for an agent

`agent-deployments.read-write`

Create A New Agent Session`rippling_create_agent_session`

Start an agent session with a prompt

`agent-sessions.read-write`

Create A New Agent Source Revision`rippling_create_agent_source_revision`

Create a source revision for an agent

`agent-source-revisions.read-write`

Create A New Agent`rippling_create_agent`

Create a new agent

`agents.read-write`

Update An Agent`rippling_update_agent`

Update an agent's name or description

`agents.read-write`

Delete An Agent`rippling_delete_agent`

Delete an agent

`agents.read-write`

Append Agent Session Message`rippling_append_agent_session_message`

Append a user prompt to an existing agent session

`agent-sessions.read-write`

Capture An Agent Session Resume State`rippling_capture_agent_session_resume_state`

Capture opaque state that can restore a compatible eval agent session

`agent-sessions.read-write`

List App Users`rippling_list_app_users`

Returns a paginated list of app users

`app-users.read`

Retrieve A Specific App User`rippling_get_app_user`

Retrieve a specific app user

`app-users.read`

List Background Check Candidates`rippling_list_background_check_candidates`

Returns a paginated list of background check candidates

`background-check-candidates.read`

Retrieve A Specific Background Check Candidate`rippling_get_background_check_candidate`

Retrieve a specific background check candidate

`background-check-candidates.read`

Create A New Background Check Candidate`rippling_create_background_check_candidate`

Create a new background check candidate

`background-check-candidates.read-write`

Update A Background Check Candidate`rippling_update_background_check_candidate`

Update a specific background check candidate

`background-check-candidates.read-write`

Delete A Background Check Candidate`rippling_delete_background_check_candidate`

Delete a background check candidate

`background-check-candidates.read-write`

List Background Check Invitations`rippling_list_background_check_invitations`

Lists background check invitations for the authenticated provider

`background-check-invitations.read`

Retrieve A Specific Background Check Invitation`rippling_get_background_check_invitation`

Retrieves a single background check invitation by Platform API ID

`background-check-invitations.read`

Create A New Background Check Invitation`rippling_create_background_check_invitation`

Creates a new background check invitation

`background-check-invitations.read-write`

Update A Background Check Invitation`rippling_update_background_check_invitation`

Updates a background check invitation

`background-check-invitations.read-write`

Delete A Background Check Invitation`rippling_delete_background_check_invitation`

Soft-deletes a background check invitation by setting isDeleted=True

`background-check-invitations.read-write`

List Background Check Nodes`rippling_list_background_check_nodes`

Lists background check nodes for the authenticated provider

`background-check-nodes.read`

Retrieve A Specific Background Check Node`rippling_get_background_check_node`

Retrieves a single background check node by Platform API ID

`background-check-nodes.read`

Create A New Background Check Node`rippling_create_background_check_node`

Creates a new background check node

`background-check-nodes.read-write`

Update A Background Check Node`rippling_update_background_check_node`

Updates a background check node

`background-check-nodes.read-write`

Delete A Background Check Node`rippling_delete_background_check_node`

Soft-deletes a background check node by setting isDeleted=True

`background-check-nodes.read-write`

List Background Check Orders`rippling_list_background_check_orders`

Lists background check orders for the authenticated provider

`background-check-orders.read`

Retrieve A Specific Background Check Order`rippling_get_background_check_order`

Retrieves a single background check order by Platform API ID

`background-check-orders.read`

Update A Background Check Order`rippling_update_background_check_order`

Accepts or rejects a background check order by updating its status

`background-check-orders.read-write`

List Background Check Packages`rippling_list_background_check_packages`

Lists background check packages (check types) offered by the authenticated provider

`background-check-packages.read`

Retrieve A Specific Background Check Package`rippling_get_background_check_package`

Retrieves a single background check package by Platform API ID

`background-check-packages.read`

Create A New Background Check Package`rippling_create_background_check_package`

Creates a new background check package

`background-check-packages.read-write`

Update A Background Check Package`rippling_update_background_check_package`

Updates a background check package

`background-check-packages.read-write`

Delete A Background Check Package`rippling_delete_background_check_package`

Soft-deletes a background check package by setting isDeleted=True

`background-check-packages.read-write`

List Background Check Reports`rippling_list_background_check_reports`

Lists background check reports for the authenticated provider

`background-check-reports.read`

Retrieve A Specific Background Check Report`rippling_get_background_check_report`

Retrieves a single background check report by Platform API ID

`background-check-reports.read`

Create A New Background Check Report`rippling_create_background_check_report`

Creates a new background check report

`background-check-reports.read-write`

Update A Background Check Report`rippling_update_background_check_report`

Updates a background check report

`background-check-reports.read-write`

Delete A Background Check Report`rippling_delete_background_check_report`

Soft-deletes a background check report by setting isDeleted=True

`background-check-reports.read-write`

List Bills`rippling_list_bills`

Returns a paginated list of bills

`bills.read`

Retrieve A Specific Bill`rippling_get_bill`

Retrieve a specific bill

`bills.read`

Update A Bill`rippling_update_bill`

Updates a bill's line items

`bills.read-write`

List Break Policies`rippling_list_break_policies`

Returns a paginated list of break policies

`break-policies.read`

List Break Types`rippling_list_break_types`

Returns a paginated list of break types

`break-types.read`

Retrieve A Specific Break Policy`rippling_get_break_policy`

Retrieve a specific break policy

`break-policies.read`

Retrieve A Specific Break Type`rippling_get_break_type`

Retrieve a specific break type

`break-types.read`

List Business Partner Groups`rippling_list_business_partner_groups`

Returns a paginated list of business partner groups

`business-partner-groups.read`

List Business Partners`rippling_list_business_partners`

Returns a paginated list of business partners

`business-partners.read`

Retrieve A Specific Business Partner Group`rippling_get_business_partner_group`

Retrieve a specific business partner group

`business-partner-groups.read`

Retrieve A Specific Business Partner`rippling_get_business_partner`

Retrieve a specific business partner

`business-partners.read`

Create A New Business Partner Group`rippling_create_business_partner_group`

Create a new business partner group

`business-partner-groups.read-write`

Create A New Business Partner`rippling_create_business_partner`

Create a new business partner

`business-partners.read-write`

Delete A Business Partner Group`rippling_delete_business_partner_group`

Delete a business partner group

`business-partner-groups.read-write`

Delete A Business Partner`rippling_delete_business_partner`

Delete a business partner

`business-partners.read-write`

List Business Structure Paths`rippling_list_business_structure_paths`

Returns a paginated list of business structure paths

`business-structure-paths.read`

Retrieve A Specific Business Structure Path`rippling_get_business_structure_path`

Retrieve a specific business structure path

`business-structure-paths.read`

Create A New Business Structure Path`rippling_create_business_structure_path`

Create a new business structure path

`business-structure-paths.read-write`

Delete A Business Structure Path`rippling_delete_business_structure_path`

Delete a Business Structure path and all of its descendant paths

`business-structure-paths.read-write`

List Candidate Applications`rippling_list_candidate_applications`

List applications for at least one candidate, job requisition, or job post

`candidate-applications.read`

List Candidates`rippling_list_candidates`

Returns a paginated list of candidates

`candidates.read`

List Card Transactions`rippling_list_card_transactions`

Returns a paginated list of card transactions

`card-transactions.read`

Retrieve A Specific Card Transaction`rippling_get_card_transaction`

Retrieve a specific card transaction

`card-transactions.read`

Update A Card Transaction`rippling_update_card_transaction`

Replace a card transaction's line items

`card-transactions.read-write`

Upload Card Transaction Attachment`rippling_upload_card_transaction_attachment`

Attach a supporting document to a card transaction

`card-transactions.read-write`

Upload Card Transaction Receipt`rippling_upload_card_transaction_receipt`

Upload a receipt to a card transaction

`card-transactions.read-write`

List Companies`rippling_list_companies`

Retrieves a paginated list of companies representing the tenant organization on Rippling

`companies.read`

List Compensation Bands Details`rippling_list_compensation_bands_details`

Returns a paginated list of compensation bands details

`compensation-bands-details.read`

List Location Factors`rippling_list_location_factors`

Returns a paginated list of location factors

`location-factors.read`

Retrieve Specific Compensation Bands Details`rippling_get_compensation_bands_details`

Retrieve a specific compensation bands detail

`compensation-bands-details.read`

Retrieve A Specific Location Factor`rippling_get_location_factor`

Retrieve a specific location factor

`location-factors.read`

List Compensations`rippling_list_compensations`

Retrieves compensation information for workers

`compensations.read`

Get Compensation`rippling_get_compensation`

Retrieves detailed compensation data for a specific compensation record

`compensations.read`

List Custom Apps`rippling_list_custom_apps`

Returns a paginated list of custom app

`custom-apps.read`

List Custom Pages`rippling_list_custom_pages`

Returns a paginated list of custom page

`custom-pages.read`

Retrieve A Specific Custom App`rippling_get_custom_app`

Retrieve a specific custom app

`custom-apps.read`

Retrieve A Specific Custom Page`rippling_get_custom_page`

Retrieve a specific custom page

`custom-pages.read`

Create A New Custom App`rippling_create_custom_app`

Create a new custom app

`custom-apps.read-write`

Create A New Custom Page`rippling_create_custom_page`

Create a new custom page

`custom-pages.read-write`

Update A Custom App`rippling_update_custom_app`

Update a specific custom app

`custom-apps.read-write`

Update A Custom Page`rippling_update_custom_page`

Update a specific custom page

`custom-pages.read-write`

Delete A Custom App`rippling_delete_custom_app`

Delete a custom app

`custom-apps.read-write`

Delete A Custom Page`rippling_delete_custom_page`

Delete a custom page

`custom-pages.read-write`

List Custom Fields`rippling_list_custom_fields`

Returns a paginated list of custom fields

`custom-fields.read`

List Custom Object Fields`rippling_list_custom_object_fields`

Returns a paginated list of custom object fields

`custom-objects.read`

Retrieve A Specific Custom Object Field`rippling_get_custom_object_field`

Retrieve a specific custom object field

`custom-objects.read`

Create A New Custom Object Field`rippling_create_custom_object_field`

Create a new custom object field

`custom-objects.read-write`

Update A Custom Object Field`rippling_update_custom_object_field`

Update a specific custom object field

`custom-objects.read-write`

Delete A Custom Object Field`rippling_delete_custom_object_field`

Delete a custom object field

`custom-objects.read-write`

List Custom Object List Views`rippling_list_custom_object_list_views`

Lists shared views and the requester's private views

`custom-objects.read`

Get Custom Object List View Capabilities`rippling_get_custom_object_list_view_capabilities`

Returns whether the authenticated caller may create private or shared views and set the company default for this object

`custom-objects.read`

Retrieve A Specific Custom Object List View`rippling_get_custom_object_list_view`

Retrieves an accessible saved view

`custom-objects.read`

Create A New Custom Object List View`rippling_create_custom_object_list_view`

Creates a grid definition using ordered field API names, RQL, sorting, visibility, and record scope

`custom-objects.read-write`

Set Default Custom Object List View`rippling_set_default_custom_object_list_view`

Replaces the company-wide default for this object with an accessible shared view identified by view\_api\_name, or supply...

`custom-objects.read-write`

Update A Custom Object List View`rippling_update_custom_object_list_view`

Updates only the supplied fields of an accessible saved view; omitted fields are preserved

`custom-objects.read-write`

Delete A Custom Object List View`rippling_delete_custom_object_list_view`

Removes an accessible saved view from the active collection and clears the company default if it references this view

`custom-objects.read-write`

List Custom Object Record Actions`rippling_list_custom_object_record_actions`

Lists callable native actions for this Custom Object

`custom-object-records.read`

List Record Detail Reference Options`rippling_list_record_detail_reference_options`

Lists eligible choices for a Create or Edit reference field

`custom-object-records.read-write`

List Record Detail Related Records`rippling_list_record_detail_related_records`

Lists readable Custom Object records in a related-list section of the parent record's effective layout

`custom-object-records.read`

List Custom Object Records`rippling_list_custom_object_records`

Returns a paginated list of custom object records

`custom-object-records.read`

Get Custom Object Record Capabilities`rippling_get_custom_object_record_capabilities`

Check whether you can create a record in this Custom Object, including when it has no records

`custom-object-records.read`

Retrieve Record Create Detail`rippling_get_record_create_detail`

Retrieves one permissioned, singular, nonpaginated Create context without persisting a record

`custom-object-records.read-write`

Retrieve Record Detail`rippling_get_record_detail`

Retrieves a Custom Object record's readable values, edit capabilities, and effective saved page layout

`custom-object-records.read`

Retrieve A Custom Object Record By External ID`rippling_get_custom_object_record_by_external_id`

Retrieve a specific custom object record by its external\_id

`custom-object-records.read`

Retrieve A Specific Custom Object Record`rippling_get_custom_object_record`

Retrieve a specific custom object record

`custom-object-records.read`

List Custom Object Records By Query`rippling_list_custom_object_records_by_query`

Lists custom object records matching optional name or owner search and RQL filters

`custom-object-records.read`

Create Or Update A Custom Object Record`rippling_upsert_custom_object_record`

Create a new custom object record, or update an existing record by external\_id

`custom-object-records.read-write`

Bulk Create Or Update Custom Object Records`rippling_bulk_upsert_custom_object_records`

Bulk create new custom object records or update existing records by external\_id

`custom-object-records.read-write`

Bulk Delete Custom Object Records`rippling_bulk_delete_custom_object_records`

Bulk delete custom object records

`custom-object-records.read-write`

Bulk Update Custom Object Records`rippling_bulk_update_custom_object_records`

Bulk update custom object records

`custom-object-records.read-write`

Update A Custom Object Record`rippling_update_custom_object_record`

Update a specific custom object record

`custom-object-records.read-write`

Delete A Custom Object Record`rippling_delete_custom_object_record`

Delete a custom object record

`custom-object-records.read-write`

List Custom Objects`rippling_list_custom_objects`

Returns a paginated list of custom objects

`custom-objects.read`

List Object Categories`rippling_list_object_categories`

Returns a paginated list of object categories

`custom-objects.read`

List Platform Capabilities`rippling_list_platform_capabilities`

Returns a paginated list of platform capabilities

`platform-capabilities.read`

Retrieve A Specific Custom Object`rippling_get_custom_object`

Retrieve a specific custom object

`custom-objects.read`

Retrieve A Specific Object Category`rippling_get_object_category`

Retrieve a specific object category

`custom-objects.read`

Create A New Custom Object`rippling_create_custom_object`

Create a new custom object

`custom-objects.read-write.owner`

Create A New Object Category`rippling_create_object_category`

Create a new object category

`custom-objects.read-write.owner`

Update A Custom Object`rippling_update_custom_object`

Update a specific custom object

`custom-objects.read-write`

Update An Object Category`rippling_update_object_category`

Update a specific object category

`custom-objects.read-write`

Delete A Custom Object`rippling_delete_custom_object`

Delete a custom object

`custom-objects.read-write`

Delete An Object Category`rippling_delete_object_category`

Delete an object category

`custom-objects.read-write`

List Custom Settings`rippling_list_custom_settings`

Returns a paginated list of custom setting

`custom-settings.read`

Retrieve A Specific Custom Setting`rippling_get_custom_setting`

Retrieve a specific custom setting

`custom-settings.read`

Create A New Custom Setting`rippling_create_custom_setting`

Create a new custom setting

`custom-settings.read-write`

Update A Custom Setting`rippling_update_custom_setting`

Update a specific custom setting

`custom-settings.read-write`

Delete A Custom Setting`rippling_delete_custom_setting`

Delete a custom setting

`custom-settings.read-write`

List Departments`rippling_list_departments`

Returns a paginated list of all departments within the organization

`departments.read`

Retrieve A Specific Department`rippling_get_department`

Retrieves details for a specific department by ID

`departments.read`

Create A New Department`rippling_create_department`

Creates a new department within the organization

`departments.read-write`

Update A Department`rippling_update_department`

Updates a department within the organization by ID

`departments.read-write`

List Device Orders`rippling_list_device_orders`

Returns a paginated list of device orders

`device-orders.read`

List Devices`rippling_list_devices`

Returns a paginated list of devices

`devices.read`

Retrieve A Specific Device Order`rippling_get_device_order`

Retrieve a specific device order

`device-orders.read`

Retrieve A Specific Device`rippling_get_device`

Retrieve a specific device

`devices.read`

List Earning Types`rippling_list_earning_types`

Lists Global Payroll earning types for selecting payroll earnings inputs

`earning-types.read`

List Earnings Inputs`rippling_list_earnings_inputs`

Returns a paginated list of earnings inputs

`earnings-inputs.read`

Create A New Earnings Input`rippling_create_earnings_input`

Create or update earnings inputs for one worker

`earnings-inputs.read-write`

Delete An Earnings Input`rippling_delete_earnings_input`

Delete an earnings input

`earnings-inputs.read-write`

Retrieve A Specific File`rippling_get_file`

Retrieve a specific file

`files.read`

Create Employee Documents In Bulk`rippling_create_employee_documents`

Create a new employee document

`employee-documents.read-write`

Create A New File`rippling_create_file`

Create a new file

`files.read-write`

List Employment Types`rippling_list_employment_types`

Returns a paginated list of employment types

`employment-types.read`

Retrieve Employment Type`rippling_get_employment_type`

Retrieves details for a specific employment type by ID

`employment-types.read`

List Entitlements`rippling_list_entitlements`

Retrieves app access entitlements for identity and access management

`entitlements.read`

List Finance Categories`rippling_list_finance_categories`

Returns a paginated list of finance categories

`finance-categories.read`

List Finance Vendors`rippling_list_finance_vendors`

Returns a paginated list of finance vendors

`finance-vendors.read`

Retrieve A Specific Finance Category`rippling_get_finance_category`

Retrieve a specific finance category

`finance-categories.read`

Retrieve A Specific Finance Vendor`rippling_get_finance_vendor`

Retrieve a specific finance vendor

`finance-vendors.read`

List Function Deployment Logs`rippling_list_function_deployment_logs`

Returns a paginated list of function deployment logs

`functions.read`

List Function Deployments`rippling_list_function_deployments`

Returns a paginated list of function deployments

`functions.read`

List Function Execution Logs`rippling_list_function_execution_logs`

Returns a paginated list of function execution logs

`function-executions.read`

List Function Executions`rippling_list_function_executions`

Returns a paginated list of function executions

`function-executions.read`

List Functions`rippling_list_functions`

Returns a paginated list of functions

`functions.read`

Retrieve A Specific Function Deployment`rippling_get_function_deployment`

Retrieve a specific function deployment

`functions.read`

Retrieve A Specific Function Execution`rippling_get_function_execution`

Retrieve a specific function execution

`function-executions.read`

Retrieve A Specific Function`rippling_get_function`

Retrieve a specific function

`functions.read`

Create A New Function Deployment`rippling_create_function_deployment`

Create a new function deployment

`functions.read-write`

Create A New Function Dev Bundle`rippling_create_function_dev_bundle`

Create a new function dev bundle

`functions.read-write`

Create A New Function Execution`rippling_create_function_execution`

Create a new function execution

`function-executions.read-write`

Create A New Function`rippling_create_function`

Create a new function

`functions.read-write`

Update A Function`rippling_update_function`

Update a function

`functions.read-write`

Delete A Function`rippling_delete_function`

Permanently delete a function

`functions.read-write`

List Headcount Positions`rippling_list_headcount_positions`

Returns a paginated list of headcount positions

`headcount-positions.read`

List Headcount Priorities`rippling_list_headcount_priorities`

Returns a paginated list of headcount priorities

`headcount-priorities.read`

Retrieve A Specific Headcount Position`rippling_get_headcount_position`

Retrieve a specific headcount position

`headcount-positions.read`

Retrieve A Specific Headcount Priority`rippling_get_headcount_priority`

Retrieve a specific headcount priority

`headcount-priorities.read`

Retrieve A Specific Draft Transition`rippling_get_draft_transition`

Retrieve the current result of an asynchronously processed draft transition request

`draft-transitions.read`

Get Hire Requirements`rippling_get_hire_requirements`

Return required fields for a country and hire type

`hire-requirements.read`

Create Draft Hires In Bulk`rippling_create_draft_hires`

Create bulk draft hire

`draft-hires.read-write`

Create A New Draft Transition`rippling_create_draft_transition`

Accept a batch of draft employment changes for asynchronous processing

`draft-transitions.read-write`

Create Hires`rippling_create_hires`

Create or resume hire records for admin review

`hires.read-write`

Retrieve SSO Information For The Current User`rippling_get_sso_me`

SSO information of the current user

`sso-me.read`

Get Permission Profile Membership`rippling_get_permission_profile_membership`

Check the authenticated caller's live assignment to an active permission profile, not its data-access grants

`permission-profiles.read`

List Job Assignment Change Log`rippling_list_job_assignment_change_log`

Returns a paginated list of attribute change logs

`job-assignments.read`

List Job Assignments`rippling_list_job_assignments`

Returns a paginated list of job assignments

`job-assignments.read`

List Scheduled Job Assignments`rippling_list_scheduled_job_assignments`

Returns a paginated list of scheduled job assignments

`scheduled-job-assignments.read`

Retrieve A Specific Job Assignment`rippling_get_job_assignment`

Retrieve a specific job assignment

`job-assignments.read`

Retrieve A Specific Scheduled Job Assignment`rippling_get_scheduled_job_assignment`

Retrieve a specific scheduled job assignment

`scheduled-job-assignments.read`

Create A New Job Assignment`rippling_create_job_assignment`

Create a new job assignment

`job-assignments.read-write`

Update A Job Assignment`rippling_update_job_assignment`

Update a specific job assignment

`job-assignments.read-write`

Delete A Job Assignment`rippling_delete_job_assignment`

Delete a job assignment

`job-assignments.read-write`

Delete A Scheduled Job Assignment`rippling_delete_scheduled_job_assignment`

Delete a scheduled job assignment

`scheduled-job-assignments.read-write`

List Job Code Change Log`rippling_list_job_code_change_log`

Returns a paginated list of attribute change logs

`job-codes.read`

List Job Codes`rippling_list_job_codes`

Returns a paginated list of job codes

`job-codes.read`

Retrieve A Specific Job Code`rippling_get_job_code`

Retrieve a specific job code

`job-codes.read`

Create A New Job Code`rippling_create_job_code`

Create a new job code

`job-codes.read-write`

Update A Job Code`rippling_update_job_code`

Update a specific job code

`job-codes.read-write`

Delete A Job Code`rippling_delete_job_code`

Delete a job code

`job-codes.read-write`

List Job Dimensions`rippling_list_job_dimensions`

Returns a paginated list of job dimensions

`job-dimensions.read`

Retrieve A Specific Job Dimension`rippling_get_job_dimension`

Retrieve a specific job dimension

`job-dimensions.read`

Create A New Job Dimension`rippling_create_job_dimension`

Create a new job dimension

`job-dimensions.read-write`

Update A Job Dimension`rippling_update_job_dimension`

Update a specific job dimension

`job-dimensions.read-write`

Delete A Job Dimension`rippling_delete_job_dimension`

Delete a job dimension

`job-dimensions.read-write`

List Job Functions`rippling_list_job_functions`

Returns a paginated list of job functions

`job-functions.read`

Retrieve A Specific Job Function`rippling_get_job_function`

Retrieve a specific job function

`job-functions.read`

List Job Pay Rate Exception Change Log`rippling_list_job_pay_rate_exception_change_log`

Returns a paginated list of attribute change logs

`job-pay-rate-exceptions.read`

List Job Pay Rate Exceptions`rippling_list_job_pay_rate_exceptions`

Returns a paginated list of job pay rate exceptions

`job-pay-rate-exceptions.read`

Retrieve A Specific Job Pay Rate Exception`rippling_get_job_pay_rate_exception`

Retrieve a specific job pay rate exception

`job-pay-rate-exceptions.read`

List Job Requisitions`rippling_list_job_requisitions`

List non-confidential active job requisitions available to the integration

`job-requisitions.read`

Retrieve A Specific Job Requisition`rippling_get_job_requisition`

Retrieve a non-confidential job requisition by identifier

`job-requisitions.read`

Get Job Requisition Pipeline`rippling_get_job_requisition_pipeline`

Returns the configured application stages in pipeline order

`job-requisitions.read`

Create A New Job Requisition`rippling_create_job_requisition`

Create a new job requisition

`job-requisitions-write.read-write`

List Kiosk Badges`rippling_list_kiosk_badges`

Returns a paginated list of kiosk badges

`kiosk-badges.read`

Retrieve A Specific Kiosk Badge`rippling_get_kiosk_badge`

Retrieve a specific kiosk badge

`kiosk-badges.read`

Create A New Kiosk Badge`rippling_create_kiosk_badge`

Create a new kiosk badge

`kiosk-badges.read-write`

Update A Kiosk Badge`rippling_update_kiosk_badge`

Update a specific kiosk badge

`kiosk-badges.read-write`

Delete A Kiosk Badge`rippling_delete_kiosk_badge`

Delete a kiosk badge

`kiosk-badges.read-write`

List Leave Accruals`rippling_list_leave_accruals`

Returns a paginated list of leave accruals

`leave-accruals.read`

Retrieve A Specific Leave Accrual`rippling_get_leave_accrual`

Retrieve a specific leave accrual

`leave-accruals.read`

Create A New Leave Accrual`rippling_create_leave_accrual`

Create a new leave accrual

`leave-accruals.read-write`

List Leave Balances`rippling_list_leave_balances`

Returns a paginated list of all leave balances within the organization

`leave-balances.read`

Retrieve A Specific Leave Balance`rippling_get_leave_balance`

Retrieves details for a specific leave balance by ID

`leave-balances.read`

List Leave Requests`rippling_list_leave_requests`

Returns a paginated list of all leave requests within the organization

`leave-requests.read`

Retrieve A Specific Leave Request`rippling_get_leave_request`

Retrieves details for a specific leave request by ID

`leave-requests.read`

Create A New Leave Request`rippling_create_leave_request`

Creates a new leave request and returns its ID and details

`leave-requests.read-write`

Update A Leave Request`rippling_update_leave_request`

Updates an existing leave request by ID

`leave-requests.read-write`

List Leave Types`rippling_list_leave_types`

Returns a paginated list of all leave types within the organization

`leave-types.read`

Retrieve A Specific Leave Type`rippling_get_leave_type`

Retrieves details for a specific leave type by ID

`leave-types.read`

List Company Legal Entities`rippling_list_company_legal_entities`

Returns a paginated list of company legal entities

`company-legal-entities.read`

List Company Legal Entity Workers`rippling_list_company_legal_entity_workers`

Returns a paginated list of company legal entity workers

`company-legal-entity-workers.read`

List Legal Entities`rippling_list_legal_entities`

Returns a paginated list of legal entities

`legal-entities.read`

Retrieve A Specific Company Legal Entity`rippling_get_company_legal_entity`

Retrieve a specific company legal entity

`company-legal-entities.read`

Retrieve A Specific Company Legal Entity Worker`rippling_get_company_legal_entity_worker`

Retrieve a specific company legal entity worker

`company-legal-entity-workers.read`

Retrieve A Specific Legal Entity`rippling_get_legal_entity`

Retrieve a specific legal entity

`legal-entities.read`

List Levels`rippling_list_levels`

Returns a paginated list of all levels within the organization

`levels.read`

Retrieve A Specific Level`rippling_get_level`

Retrieves details for a specific level by ID

`levels.read`

Create A New Level`rippling_create_level`

Create a new level

`levels.read-write`

Update A Level`rippling_update_level`

Update a specific level

`levels.read-write`

Delete A Level`rippling_delete_level`

Delete a level

`levels.read-write`

List Supported Metadata Types`rippling_list_metadata_types`

List component types that can be described, validated, and deployed by metadata composer

`metadata.read`

Get Metadata Deployment Run`rippling_get_metadata_deployment_run`

Poll a metadata deployment run until the terminal field is true

`metadata.read`

Get Metadata Schema`rippling_get_metadata_schema`

Return the JSON schema for one supported metadata component type

`metadata.read`

Get Async Metadata Validation Run Status`rippling_get_metadata_validation_run`

Poll a metadata validation run until the terminal field is true

`metadata.read`

Create A New Metadata Deployment Run`rippling_create_metadata_deployment_run`

Queue deployment for a metadata component package and return a run id for polling

`metadata.read-write`

Create A New Metadata Validation Run`rippling_create_metadata_validation_run`

Queue validation for a metadata component package and return a run id for polling

`metadata.read-write`

Deploy A Metadata Component Package`rippling_deploy_metadata_components`

Create or update the supplied metadata components as one package

`metadata.read-write`

Extract Metadata Components By Identifier`rippling_extract_metadata_components_by_identifiers`

Extract exact metadata components and their readable dependency closure

`metadata.read`

Extract Metadata Components`rippling_extract_metadata_components`

Extract the company's selectable metadata components, optionally filtered by a search query

`metadata.read`

Validate Metadata Components`rippling_validate_metadata_components`

Validate a complete metadata component package without installing it

`metadata.read-write`

List Payroll Runs`rippling_list_payroll_runs`

Returns a paginated list of payroll runs

`payroll-runs.read`

List Worker Payroll Records`rippling_list_worker_payroll_records`

Returns a paginated list of worker payroll records for a payroll run

`worker-payroll-records.read`

Retrieve A Specific Payroll Run`rippling_get_payroll_run`

Retrieve a specific payroll run

`payroll-runs.read`

List Reimbursements`rippling_list_reimbursements`

Returns a paginated list of reimbursements

`reimbursements.read`

Retrieve A Specific Reimbursement`rippling_get_reimbursement`

Retrieve a specific reimbursement

`reimbursements.read`

Update A Reimbursement`rippling_update_reimbursement`

Replace a reimbursement's line items

`reimbursements.read-write`

Upload Reimbursement Attachment`rippling_upload_reimbursement_attachment`

Attach a supporting document to a reimbursement

`reimbursements.read-write`

Upload Reimbursement Receipt`rippling_upload_reimbursement_receipt`

Upload a receipt to a reimbursement, replacing any existing one

`reimbursements.read-write`

Retrieve A Specific Report Run`rippling_get_report_run`

Retrieve the status and data for a specific report run

`report-runs.read`

Get Report Available Filters`rippling_get_report_available_filters`

Returns the list of fields that can be used to filter a report run, along with the operators each field supports

`reports.read`

Retrieve A Specific Report`rippling_get_report`

Retrieve a specific report by its ID

`reports.read`

Trigger A Report Run`rippling_trigger_report_run`

Trigger a new report run

`report-runs.read-write`

List Schedules`rippling_list_schedules`

Returns a paginated list of schedules

`schedules.read`

Retrieve A Specific Schedule`rippling_get_schedule`

Retrieve a specific schedule

`schedules.read`

Create A New Schedule`rippling_create_schedule`

Create a new schedule

`schedules.read-write`

Update A Schedule`rippling_update_schedule`

Update a specific schedule

`schedules.read-write`

List Shift Assignments`rippling_list_shift_assignments`

Returns a paginated list of shift assignments

`shiftassignments.read`

Retrieve A Specific Shift Assignment`rippling_get_shift_assignment`

Retrieve a specific shift assignment

`shiftassignments.read`

Create A New Shift Assignment`rippling_create_shift_assignment`

Create a new shift assignment

`shiftassignments.read-write`

Update Shift Assignment Custom Fields`rippling_update_shift_assignment_custom_fields`

Update custom fields for a shift assignment

`shiftassignments.read-write`

Update A Shift Assignment`rippling_update_shift_assignment`

Update a specific shift assignment

`shiftassignments.read-write`

List Shift Inputs`rippling_list_shift_inputs`

Returns a paginated list of shift inputs

`shift-inputs.read`

Retrieve A Specific Shift Input`rippling_get_shift_input`

Retrieve a specific shift input

`shift-inputs.read`

Create A New Shift Input`rippling_create_shift_input`

Create a new shift input

`shift-inputs.read-write`

Update A Shift Input`rippling_update_shift_input`

Update a specific shift input

`shift-inputs.read-write`

Delete A Shift Input`rippling_delete_shift_input`

Delete a shift input

`shift-inputs.read-write`

List Site Files`rippling_list_site_files`

List files and persisted directories from the active bundle manifest

`sites.read`

List Sites`rippling_list_sites`

Retrieves sites that the user has view or edit access on

`sites.read`

Retrieve A Specific Site`rippling_get_site`

Retrieve a specific site

`sites.read`

Create A New Site`rippling_create_site`

Create a new site from a staged upload

`sites.read-write`

Update A Site`rippling_update_site`

Update a site

`sites.read-write`

Delete A Site`rippling_delete_site`

Delete a site

`sites.read-write`

Apply Site File Operations`rippling_apply_site_file_operations`

Apply file and directory operations atomically against the active bundle

`sites.read-write`

Presign Site Upload Batch`rippling_presign_site_upload_batch`

Create staged upload records and return presigned S3 POST credentials

`sites.read-write`

List Software Deployments`rippling_list_software_deployments`

Returns a paginated list of software deployments

`software-deployments.read`

Retrieve A Specific Software Deployment`rippling_get_software_deployment`

Retrieve a specific software deployment

`software-deployments.read`

Create A New Software Deployment`rippling_create_software_deployment`

Create a new software deployment

`software-deployments.read-write`

Update A Software Deployment`rippling_update_software_deployment`

Update a specific software deployment

`software-deployments.read-write`

Delete A Software Deployment`rippling_delete_software_deployment`

Delete a software deployment

`software-deployments.read-write`

List Supergroup Exclusion Members`rippling_list_supergroup_exclusion_members`

Retrieve supergroup exclusion members matching the input parameters

`supergroups.read`

List Supergroup Inclusion Members`rippling_list_supergroup_inclusion_members`

Retrieve supergroup inclusion members matching the input parameters

`supergroups.read`

List Supergroup Members`rippling_list_supergroup_members`

Retrieve members for a supergroup

`supergroups.read`

List Supergroups`rippling_list_supergroups`

Retrieve supergroups matching the input parameters

`supergroups.read`

Retrieve A Specific Supergroup`rippling_get_supergroup`

Retrieve a specific supergroup

`supergroups.read`

Update Supergroup Exclusion Members`rippling_update_supergroup_exclusion_members`

Update the list of supergroup exclusion members

`supergroups.read-write`

Update Supergroup Inclusion Members`rippling_update_supergroup_inclusion_members`

Update the list of supergroup inclusion members

`supergroups.read-write`

List Teams`rippling_list_teams`

Retrieves teams with parent-child relationships and hierarchies

`supergroups.read`

Get Team`rippling_get_team`

Retrieves detailed information about a specific team

`supergroups.read`

Create A New Team`rippling_create_team`

Create a new team

`teams.read-write`

Update A Team`rippling_update_team`

Update a specific team

`teams.read-write`

Delete A Team`rippling_delete_team`

Delete a team

`teams.read-write`

List Time Cards`rippling_list_time_cards`

Returns a paginated list of all timecards for the organization

`time-cards.read`

Retrieve A Specific Time Card`rippling_get_time_card`

Retrieves details for a specific timecard by ID

`time-cards.read`

List Time Entries`rippling_list_time_entries`

Returns a paginated list of all time entries for the organization

`time-entries.read`

Retrieve A Specific Time Entry`rippling_get_time_entry`

Retrieves details for a specific time entry by ID

`time-entries.read`

Create A New Time Entry`rippling_create_time_entry`

Creates a new time entry and returns its ID and details

`time-entries.read-write`

Update A Time Entry`rippling_update_time_entry`

Updates an existing time entry by ID using partial update semantics

`time-entries.read-write`

Delete A Time Entry`rippling_delete_time_entry`

Permanently deletes a time entry by ID

`time-entries.read-write`

List Titles`rippling_list_titles`

Returns a paginated list of titles

`titles.read`

Retrieve A Specific Title`rippling_get_title`

Retrieve a specific title

`titles.read`

Create A New Title`rippling_create_title`

Create a new title

`titles.read-write`

Update A Title`rippling_update_title`

Update a specific title

`titles.read-write`

Delete A Title`rippling_delete_title`

Delete a title

`titles.read-write`

List Tracks`rippling_list_tracks`

Returns a paginated list of all career tracks within the organization

`tracks.read`

Retrieve A Specific Track`rippling_get_track`

Retrieves details for a specific career track by ID

`tracks.read`

Create A New Track`rippling_create_track`

Create a new track

`tracks.read-write`

Update A Track`rippling_update_track`

Update a specific track

`tracks.read-write`

Delete A Track`rippling_delete_track`

Delete a track

`tracks.read-write`

List Unassigned Shifts`rippling_list_unassigned_shifts`

Returns a paginated list of unassigned shifts

`unassignedshifts.read`

Retrieve A Specific Unassigned Shift`rippling_get_unassigned_shift`

Retrieve a specific unassigned shift

`unassignedshifts.read`

Create A New Unassigned Shift`rippling_create_unassigned_shift`

Create a new unassigned shift

`unassignedshifts.read-write`

Update Unassigned Shift Custom Fields`rippling_update_unassigned_shift_custom_fields`

Update custom fields for an unassigned shift

`unassignedshifts.read-write`

Update An Unassigned Shift`rippling_update_unassigned_shift`

Update a specific unassigned shift

`unassignedshifts.read-write`

Assign A Worker To An Unassigned Shift`rippling_assign_unassigned_shift`

Assign a worker to an unassigned shift (open shift)

`unassignedshifts.read-write`

List Users`rippling_list_users`

Retrieves a paginated list of all users in the system

`users.read`

Get User`rippling_get_user`

Fetches detailed user information including name, emails, and addresses

`users.read`

List Variable Compensation Payout Labels`rippling_list_variable_compensation_payout_labels`

List payout source and group labels

`variable-compensation-payout-labels.read`

List Variable Compensation Payout Types`rippling_list_variable_compensation_payout_types`

List system and custom payout types with per-entity earning mappings

`variable-compensation-payout-types.read`

List Variable Compensation Payouts`rippling_list_variable_compensation_payouts`

List variable compensation payouts

`variable-compensation-payouts.read`

Retrieve A Specific Variable Compensation Payout Label`rippling_get_variable_compensation_payout_label`

Retrieve a specific payout source or group label

`variable-compensation-payout-labels.read`

Retrieve A Specific Variable Compensation Payout Type`rippling_get_variable_compensation_payout_type`

Retrieve a specific variable compensation payout type by key

`variable-compensation-payout-types.read`

Retrieve A Specific Variable Compensation Payout`rippling_get_variable_compensation_payout`

Retrieve a specific variable compensation payout

`variable-compensation-payouts.read`

Create A New Variable Compensation Payout Label`rippling_create_variable_compensation_payout_label`

Get or create a source or group label

`variable-compensation-payout-labels.read-write`

Create A New Variable Compensation Payout Type`rippling_create_variable_compensation_payout_type`

Create a custom payout type

`variable-compensation-payout-types.read-write`

Create A New Variable Compensation Payout`rippling_create_variable_compensation_payout`

Create or update one payout

`variable-compensation-payouts.read-write`

Update A Variable Compensation Payout Label`rippling_update_variable_compensation_payout_label`

Update a specific variable compensation payout label

`variable-compensation-payout-labels.read-write`

Update A Variable Compensation Payout Type`rippling_update_variable_compensation_payout_type`

Update a custom payout type's display name or per-entity earning mappings

`variable-compensation-payout-types.read-write`

Delete A Variable Compensation Payout Type`rippling_delete_variable_compensation_payout_type`

Delete a custom payout type

`variable-compensation-payout-types.read-write`

Cancel A Scheduled Payout`rippling_cancel_scheduled_payout`

SCHEDULED and EVALUATION\_FAILED payouts can be cancelled; cancelling an already cancelled payout returns it unchanged

`scheduled-payouts.read-write`

List Scheduled Payouts`rippling_list_scheduled_payouts`

List scheduled payouts, including CUSTOM payouts that can be cancelled

`scheduled-payouts.read`

Retrieve A Specific Scheduled Payout`rippling_get_scheduled_payout`

Retrieve a specific scheduled payout by ID

`scheduled-payouts.read`

Create A New Scheduled Payout`rippling_create_scheduled_payout`

Create or update one CUSTOM scheduled payout, upserted by client and external\_id

`scheduled-payouts.read-write`

List Worker Change Fields`rippling_list_worker_change_fields`

Returns a paginated list of worker change fields

`worker-change-fields.read`

List Worker Changes`rippling_list_worker_changes`

Returns a paginated list of worker changes

`worker-changes.read`

Retrieve A Specific Worker Change`rippling_get_worker_change`

Retrieve a specific worker change

`worker-changes.read`

List Workers`rippling_list_workers`

Retrieves a list of workers with filtering, expansion, and sorting capabilities

`workers.read`

Get Worker`rippling_get_worker`

Retrieves detailed information about a single worker by ID

`workers.read`

List Worker Time Splits`rippling_list_worker_time_splits`

Returns a paginated list of worker time splits

`worker-time-splits.read`

Retrieve A Specific Worker Time Split`rippling_get_worker_time_split`

Retrieve a specific worker time split

`worker-time-splits.read`

Create A New Worker Time Split`rippling_create_worker_time_split`

Create a new worker time split

`worker-time-splits.read-write`

Update A Worker Time Split`rippling_update_worker_time_split`

Update a specific worker time split

`worker-time-splits.read-write`

Delete A Worker Time Split`rippling_delete_worker_time_split`

Delete a worker time split

`worker-time-splits.read-write`

List Workflows`rippling_list_workflows`

List workflows

`workflows.read`

Retrieve A Workflow Execution`rippling_get_workflow_execution`

Returns a workflow execution's current status

`workflow-executions.read`

Retrieve A Workflow`rippling_get_workflow`

Retrieve a workflow

`workflows.read`

Create A New Workflow Execution`rippling_create_workflow_execution`

Launches a new execution of the workflow's current published version

`workflow-executions.read-write`

Create A New Workflow`rippling_create_workflow`

Create a workflow

`workflows.read-write`

Create A New Workflow Action Execution`rippling_create_workflow_action_execution`

Creates a workflow action execution

`workflow-action-executions.read-write`

Update A Workflow`rippling_update_workflow`

Update a workflow

`workflows.read-write`

Delete A Workflow`rippling_delete_workflow`

Delete a workflow

`workflows.read-write`

List Work Locations`rippling_list_work_locations`

Returns a paginated list of all work locations configured for the organization

`work-locations.read-write`

Retrieve A Specific Work Location`rippling_get_work_location`

Retrieves details for a specific work location by ID

`work-locations.read-write`

Create A New Work Location`rippling_create_work_location`

Create a new work location

`work-locations.read-write`

Update A Work Location`rippling_update_work_location`

Update a specific work location

`work-locations.read-write`

Delete A Work Location`rippling_delete_work_location`

Delete a work location

`work-locations.read-write`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.