Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.
API Token · Connector Profile
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 (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
API Token · Link Account
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
|
No scopes found
365 actions
Action
Description
Required scopes
List Activity Log
Lists only Activity Log events retained from the last 90 days that are visible to the caller
Retrieve A Specific Activity Log
Retrieves one Activity Log event from the same 90-day visibility set as the list endpoint
List Agent Deployments
Returns a paginated list of deployments for an agent
List Agent Session Events
List events for an agent session after an optional sequence number
List Agent Sessions
Returns a paginated list of sessions for an agent
List Agent Source Revisions
Returns a paginated list of source revisions for an agent
List Agents
List locally created agents and company-installed global agents
Retrieve A Specific Agent Deployment
Retrieve a deployment for an agent
Retrieve An Agent Session
Retrieve an agent session, including its terminal output or error when available
Retrieve An Agent Source Revision
Retrieve a source revision for an agent
Retrieve A Specific Agent
Retrieve a locally created agent or a company-installed global agent
Create A New Agent Deployment
Deploy a source revision for an agent
Create A New Agent Session
Start an agent session with a prompt
Create A New Agent Source Revision
Create a source revision for an agent
Create A New Agent
Create a new agent
Update An Agent
Update an agent’s name or description
Delete An Agent
Delete an agent
Append Agent Session Message
Append a user prompt to an existing agent session
Capture An Agent Session Resume State
Capture opaque state that can restore a compatible eval agent session
List App Users
Returns a paginated list of app users
Retrieve A Specific App User
Retrieve a specific app user
List Background Check Candidates
Returns a paginated list of background check candidates
Retrieve A Specific Background Check Candidate
Retrieve a specific background check candidate
Create A New Background Check Candidate
Create a new background check candidate
Update A Background Check Candidate
Update a specific background check candidate
Delete A Background Check Candidate
Delete a background check candidate
List Background Check Invitations
Lists background check invitations for the authenticated provider
Retrieve A Specific Background Check Invitation
Retrieves a single background check invitation by Platform API ID
Create A New Background Check Invitation
Creates a new background check invitation
Update A Background Check Invitation
Updates a background check invitation
Delete A Background Check Invitation
Soft-deletes a background check invitation by setting isDeleted=True
List Background Check Nodes
Lists background check nodes for the authenticated provider
Retrieve A Specific Background Check Node
Retrieves a single background check node by Platform API ID
Create A New Background Check Node
Creates a new background check node
Update A Background Check Node
Updates a background check node
Delete A Background Check Node
Soft-deletes a background check node by setting isDeleted=True
List Background Check Orders
Lists background check orders for the authenticated provider
Retrieve A Specific Background Check Order
Retrieves a single background check order by Platform API ID
Update A Background Check Order
Accepts or rejects a background check order by updating its status
List Background Check Packages
Lists background check packages (check types) offered by the authenticated provider
Retrieve A Specific Background Check Package
Retrieves a single background check package by Platform API ID
Create A New Background Check Package
Creates a new background check package
Update A Background Check Package
Updates a background check package
Delete A Background Check Package
Soft-deletes a background check package by setting isDeleted=True
List Background Check Reports
Lists background check reports for the authenticated provider
Retrieve A Specific Background Check Report
Retrieves a single background check report by Platform API ID
Create A New Background Check Report
Creates a new background check report
Update A Background Check Report
Updates a background check report
Delete A Background Check Report
Soft-deletes a background check report by setting isDeleted=True
List Bills
Returns a paginated list of bills
Retrieve A Specific Bill
Retrieve a specific bill
Update A Bill
Updates a bill’s line items
List Break Policies
Returns a paginated list of break policies
List Break Types
Returns a paginated list of break types
Retrieve A Specific Break Policy
Retrieve a specific break policy
Retrieve A Specific Break Type
Retrieve a specific break type
List Business Partner Groups
Returns a paginated list of business partner groups
List Business Partners
Returns a paginated list of business partners
Retrieve A Specific Business Partner Group
Retrieve a specific business partner group
Retrieve A Specific Business Partner
Retrieve a specific business partner
Create A New Business Partner Group
Create a new business partner group
Create A New Business Partner
Create a new business partner
Delete A Business Partner Group
Delete a business partner group
Delete A Business Partner
Delete a business partner
List Business Structure Paths
Returns a paginated list of business structure paths
Retrieve A Specific Business Structure Path
Retrieve a specific business structure path
Create A New Business Structure Path
Create a new business structure path
Delete A Business Structure Path
Delete a Business Structure path and all of its descendant paths
List Candidate Applications
List applications for at least one candidate, job requisition, or job post
List Candidates
Returns a paginated list of candidates
List Card Transactions
Returns a paginated list of card transactions
Retrieve A Specific Card Transaction
Retrieve a specific card transaction
Update A Card Transaction
Replace a card transaction’s line items
Upload Card Transaction Attachment
Attach a supporting document to a card transaction
Upload Card Transaction Receipt
Upload a receipt to a card transaction
List Companies
Retrieves a paginated list of companies representing the tenant organization on Rippling
List Compensation Bands Details
Returns a paginated list of compensation bands details
List Location Factors
Returns a paginated list of location factors
Retrieve Specific Compensation Bands Details
Retrieve a specific compensation bands detail
Retrieve A Specific Location Factor
Retrieve a specific location factor
List Compensations
Retrieves compensation information for workers
Get Compensation
Retrieves detailed compensation data for a specific compensation record
List Custom Apps
Returns a paginated list of custom app
List Custom Pages
Returns a paginated list of custom page
Retrieve A Specific Custom App
Retrieve a specific custom app
Retrieve A Specific Custom Page
Retrieve a specific custom page
Create A New Custom App
Create a new custom app
Create A New Custom Page
Create a new custom page
Update A Custom App
Update a specific custom app
Update A Custom Page
Update a specific custom page
Delete A Custom App
Delete a custom app
Delete A Custom Page
Delete a custom page
List Custom Fields
Returns a paginated list of custom fields
List Custom Object Fields
Returns a paginated list of custom object fields
Retrieve A Specific Custom Object Field
Retrieve a specific custom object field
Create A New Custom Object Field
Create a new custom object field
Update A Custom Object Field
Update a specific custom object field
Delete A Custom Object Field
Delete a custom object field
List Custom Object List Views
Lists shared views and the requester’s private views
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
Retrieve A Specific Custom Object List View
Retrieves an accessible saved view
Create A New Custom Object List View
Creates a grid definition using ordered field API names, RQL, sorting, visibility, and record scope
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…
Update A Custom Object List View
Updates only the supplied fields of an accessible saved view; omitted fields are preserved
Delete A Custom Object List View
Removes an accessible saved view from the active collection and clears the company default if it references this view
List Custom Object Record Actions
Lists callable native actions for this Custom Object
List Record Detail Reference Options
Lists eligible choices for a Create or Edit reference field
List Record Detail Related Records
Lists readable Custom Object records in a related-list section of the parent record’s effective layout
List Custom Object Records
Returns a paginated list of custom object records
Get Custom Object Record Capabilities
Check whether you can create a record in this Custom Object, including when it has no records
Retrieve Record Create Detail
Retrieves one permissioned, singular, nonpaginated Create context without persisting a record
Retrieve Record Detail
Retrieves a Custom Object record’s readable values, edit capabilities, and effective saved page layout
Retrieve A Custom Object Record By External ID
Retrieve a specific custom object record by its external_id
Retrieve A Specific Custom Object Record
Retrieve a specific custom object record
List Custom Object Records By Query
Lists custom object records matching optional name or owner search and RQL filters
Create Or Update A Custom Object Record
Create a new custom object record, or update an existing record by external_id
Bulk Create Or Update Custom Object Records
Bulk create new custom object records or update existing records by external_id
Bulk Delete Custom Object Records
Bulk delete custom object records
Bulk Update Custom Object Records
Bulk update custom object records
Update A Custom Object Record
Update a specific custom object record
Delete A Custom Object Record
Delete a custom object record
List Custom Objects
Returns a paginated list of custom objects
List Object Categories
Returns a paginated list of object categories
List Platform Capabilities
Returns a paginated list of platform capabilities
Retrieve A Specific Custom Object
Retrieve a specific custom object
Retrieve A Specific Object Category
Retrieve a specific object category
Create A New Custom Object
Create a new custom object
Create A New Object Category
Create a new object category
Update A Custom Object
Update a specific custom object
Update An Object Category
Update a specific object category
Delete A Custom Object
Delete a custom object
Delete An Object Category
Delete an object category
List Custom Settings
Returns a paginated list of custom setting
Retrieve A Specific Custom Setting
Retrieve a specific custom setting
Create A New Custom Setting
Create a new custom setting
Update A Custom Setting
Update a specific custom setting
Delete A Custom Setting
Delete a custom setting
List Departments
Returns a paginated list of all departments within the organization
Retrieve A Specific Department
Retrieves details for a specific department by ID
Create A New Department
Creates a new department within the organization
Update A Department
Updates a department within the organization by ID
List Device Orders
Returns a paginated list of device orders
List Devices
Returns a paginated list of devices
Retrieve A Specific Device Order
Retrieve a specific device order
Retrieve A Specific Device
Retrieve a specific device
List Earning Types
Lists Global Payroll earning types for selecting payroll earnings inputs
List Earnings Inputs
Returns a paginated list of earnings inputs
Create A New Earnings Input
Create or update earnings inputs for one worker
Delete An Earnings Input
Delete an earnings input
Retrieve A Specific File
Retrieve a specific file
Create Employee Documents In Bulk
Create a new employee document
Create A New File
Create a new file
List Employment Types
Returns a paginated list of employment types
Retrieve Employment Type
Retrieves details for a specific employment type by ID
List Entitlements
Retrieves app access entitlements for identity and access management
List Finance Categories
Returns a paginated list of finance categories
List Finance Vendors
Returns a paginated list of finance vendors
Retrieve A Specific Finance Category
Retrieve a specific finance category
Retrieve A Specific Finance Vendor
Retrieve a specific finance vendor
List Function Deployment Logs
Returns a paginated list of function deployment logs
List Function Deployments
Returns a paginated list of function deployments
List Function Execution Logs
Returns a paginated list of function execution logs
List Function Executions
Returns a paginated list of function executions
List Functions
Returns a paginated list of functions
Retrieve A Specific Function Deployment
Retrieve a specific function deployment
Retrieve A Specific Function Execution
Retrieve a specific function execution
Retrieve A Specific Function
Retrieve a specific function
Create A New Function Deployment
Create a new function deployment
Create A New Function Dev Bundle
Create a new function dev bundle
Create A New Function Execution
Create a new function execution
Create A New Function
Create a new function
Update A Function
Update a function
Delete A Function
Permanently delete a function
List Headcount Positions
Returns a paginated list of headcount positions
List Headcount Priorities
Returns a paginated list of headcount priorities
Retrieve A Specific Headcount Position
Retrieve a specific headcount position
Retrieve A Specific Headcount Priority
Retrieve a specific headcount priority
Retrieve A Specific Draft Transition
Retrieve the current result of an asynchronously processed draft transition request
Get Hire Requirements
Return required fields for a country and hire type
Create Draft Hires In Bulk
Create bulk draft hire
Create A New Draft Transition
Accept a batch of draft employment changes for asynchronous processing
Create Hires
Create or resume hire records for admin review
Retrieve SSO Information For The Current User
SSO information of the current user
Get Permission Profile Membership
Check the authenticated caller’s live assignment to an active permission profile, not its data-access grants
List Job Assignment Change Log
Returns a paginated list of attribute change logs
List Job Assignments
Returns a paginated list of job assignments
List Scheduled Job Assignments
Returns a paginated list of scheduled job assignments
Retrieve A Specific Job Assignment
Retrieve a specific job assignment
Retrieve A Specific Scheduled Job Assignment
Retrieve a specific scheduled job assignment
Create A New Job Assignment
Create a new job assignment
Update A Job Assignment
Update a specific job assignment
Delete A Job Assignment
Delete a job assignment
Delete A Scheduled Job Assignment
Delete a scheduled job assignment
List Job Code Change Log
Returns a paginated list of attribute change logs
List Job Codes
Returns a paginated list of job codes
Retrieve A Specific Job Code
Retrieve a specific job code
Create A New Job Code
Create a new job code
Update A Job Code
Update a specific job code
Delete A Job Code
Delete a job code
List Job Dimensions
Returns a paginated list of job dimensions
Retrieve A Specific Job Dimension
Retrieve a specific job dimension
Create A New Job Dimension
Create a new job dimension
Update A Job Dimension
Update a specific job dimension
Delete A Job Dimension
Delete a job dimension
List Job Functions
Returns a paginated list of job functions
Retrieve A Specific Job Function
Retrieve a specific job function
List Job Pay Rate Exception Change Log
Returns a paginated list of attribute change logs
List Job Pay Rate Exceptions
Returns a paginated list of job pay rate exceptions
Retrieve A Specific Job Pay Rate Exception
Retrieve a specific job pay rate exception
List Job Requisitions
List non-confidential active job requisitions available to the integration
Retrieve A Specific Job Requisition
Retrieve a non-confidential job requisition by identifier
Get Job Requisition Pipeline
Returns the configured application stages in pipeline order
Create A New Job Requisition
Create a new job requisition
List Kiosk Badges
Returns a paginated list of kiosk badges
Retrieve A Specific Kiosk Badge
Retrieve a specific kiosk badge
Create A New Kiosk Badge
Create a new kiosk badge
Update A Kiosk Badge
Update a specific kiosk badge
Delete A Kiosk Badge
Delete a kiosk badge
List Leave Accruals
Returns a paginated list of leave accruals
Retrieve A Specific Leave Accrual
Retrieve a specific leave accrual
Create A New Leave Accrual
Create a new leave accrual
List Leave Balances
Returns a paginated list of all leave balances within the organization
Retrieve A Specific Leave Balance
Retrieves details for a specific leave balance by ID
List Leave Requests
Returns a paginated list of all leave requests within the organization
Retrieve A Specific Leave Request
Retrieves details for a specific leave request by ID
Create A New Leave Request
Creates a new leave request and returns its ID and details
Update A Leave Request
Updates an existing leave request by ID
List Leave Types
Returns a paginated list of all leave types within the organization
Retrieve A Specific Leave Type
Retrieves details for a specific leave type by ID
List Company Legal Entities
Returns a paginated list of company legal entities
List Company Legal Entity Workers
Returns a paginated list of company legal entity workers
List Legal Entities
Returns a paginated list of legal entities
Retrieve A Specific Company Legal Entity
Retrieve a specific company legal entity
Retrieve A Specific Company Legal Entity Worker
Retrieve a specific company legal entity worker
Retrieve A Specific Legal Entity
Retrieve a specific legal entity
List Levels
Returns a paginated list of all levels within the organization
Retrieve A Specific Level
Retrieves details for a specific level by ID
Create A New Level
Create a new level
Update A Level
Update a specific level
Delete A Level
Delete a level
List Supported Metadata Types
List component types that can be described, validated, and deployed by metadata composer
Get Metadata Deployment Run
Poll a metadata deployment run until the terminal field is true
Get Metadata Schema
Return the JSON schema for one supported metadata component type
Get Async Metadata Validation Run Status
Poll a metadata validation run until the terminal field is true
Create A New Metadata Deployment Run
Queue deployment for a metadata component package and return a run id for polling
Create A New Metadata Validation Run
Queue validation for a metadata component package and return a run id for polling
Deploy A Metadata Component Package
Create or update the supplied metadata components as one package
Extract Metadata Components By Identifier
Extract exact metadata components and their readable dependency closure
Extract Metadata Components
Extract the company’s selectable metadata components, optionally filtered by a search query
Validate Metadata Components
Validate a complete metadata component package without installing it
List Payroll Runs
Returns a paginated list of payroll runs
List Worker Payroll Records
Returns a paginated list of worker payroll records for a payroll run
Retrieve A Specific Payroll Run
Retrieve a specific payroll run
List Reimbursements
Returns a paginated list of reimbursements
Retrieve A Specific Reimbursement
Retrieve a specific reimbursement
Update A Reimbursement
Replace a reimbursement’s line items
Upload Reimbursement Attachment
Attach a supporting document to a reimbursement
Upload Reimbursement Receipt
Upload a receipt to a reimbursement, replacing any existing one
Retrieve A Specific Report Run
Retrieve the status and data for a specific report run
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
Retrieve A Specific Report
Retrieve a specific report by its ID
Trigger A Report Run
Trigger a new report run
List Schedules
Returns a paginated list of schedules
Retrieve A Specific Schedule
Retrieve a specific schedule
Create A New Schedule
Create a new schedule
Update A Schedule
Update a specific schedule
List Shift Assignments
Returns a paginated list of shift assignments
Retrieve A Specific Shift Assignment
Retrieve a specific shift assignment
Create A New Shift Assignment
Create a new shift assignment
Update Shift Assignment Custom Fields
Update custom fields for a shift assignment
Update A Shift Assignment
Update a specific shift assignment
List Shift Inputs
Returns a paginated list of shift inputs
Retrieve A Specific Shift Input
Retrieve a specific shift input
Create A New Shift Input
Create a new shift input
Update A Shift Input
Update a specific shift input
Delete A Shift Input
Delete a shift input
List Site Files
List files and persisted directories from the active bundle manifest
List Sites
Retrieves sites that the user has view or edit access on
Retrieve A Specific Site
Retrieve a specific site
Create A New Site
Create a new site from a staged upload
Update A Site
Update a site
Delete A Site
Delete a site
Apply Site File Operations
Apply file and directory operations atomically against the active bundle
Presign Site Upload Batch
Create staged upload records and return presigned S3 POST credentials
List Software Deployments
Returns a paginated list of software deployments
Retrieve A Specific Software Deployment
Retrieve a specific software deployment
Create A New Software Deployment
Create a new software deployment
Update A Software Deployment
Update a specific software deployment
Delete A Software Deployment
Delete a software deployment
List Supergroup Exclusion Members
Retrieve supergroup exclusion members matching the input parameters
List Supergroup Inclusion Members
Retrieve supergroup inclusion members matching the input parameters
List Supergroup Members
Retrieve members for a supergroup
List Supergroups
Retrieve supergroups matching the input parameters
Retrieve A Specific Supergroup
Retrieve a specific supergroup
Update Supergroup Exclusion Members
Update the list of supergroup exclusion members
Update Supergroup Inclusion Members
Update the list of supergroup inclusion members
List Teams
Retrieves teams with parent-child relationships and hierarchies
Get Team
Retrieves detailed information about a specific team
Create A New Team
Create a new team
Update A Team
Update a specific team
Delete A Team
Delete a team
List Time Cards
Returns a paginated list of all timecards for the organization
Retrieve A Specific Time Card
Retrieves details for a specific timecard by ID
List Time Entries
Returns a paginated list of all time entries for the organization
Retrieve A Specific Time Entry
Retrieves details for a specific time entry by ID
Create A New Time Entry
Creates a new time entry and returns its ID and details
Update A Time Entry
Updates an existing time entry by ID using partial update semantics
Delete A Time Entry
Permanently deletes a time entry by ID
List Titles
Returns a paginated list of titles
Retrieve A Specific Title
Retrieve a specific title
Create A New Title
Create a new title
Update A Title
Update a specific title
Delete A Title
Delete a title
List Tracks
Returns a paginated list of all career tracks within the organization
Retrieve A Specific Track
Retrieves details for a specific career track by ID
Create A New Track
Create a new track
Update A Track
Update a specific track
Delete A Track
Delete a track
List Unassigned Shifts
Returns a paginated list of unassigned shifts
Retrieve A Specific Unassigned Shift
Retrieve a specific unassigned shift
Create A New Unassigned Shift
Create a new unassigned shift
Update Unassigned Shift Custom Fields
Update custom fields for an unassigned shift
Update An Unassigned Shift
Update a specific unassigned shift
Assign A Worker To An Unassigned Shift
Assign a worker to an unassigned shift (open shift)
List Users
Retrieves a paginated list of all users in the system
Get User
Fetches detailed user information including name, emails, and addresses
List Variable Compensation Payout Labels
List payout source and group labels
List Variable Compensation Payout Types
List system and custom payout types with per-entity earning mappings
List Variable Compensation Payouts
List variable compensation payouts
Retrieve A Specific Variable Compensation Payout Label
Retrieve a specific payout source or group label
Retrieve A Specific Variable Compensation Payout Type
Retrieve a specific variable compensation payout type by key
Retrieve A Specific Variable Compensation Payout
Retrieve a specific variable compensation payout
Create A New Variable Compensation Payout Label
Get or create a source or group label
Create A New Variable Compensation Payout Type
Create a custom payout type
Create A New Variable Compensation Payout
Create or update one payout
Update A Variable Compensation Payout Label
Update a specific variable compensation payout label
Update A Variable Compensation Payout Type
Update a custom payout type’s display name or per-entity earning mappings
Delete A Variable Compensation Payout Type
Delete a custom payout type
Cancel A Scheduled Payout
SCHEDULED and EVALUATION_FAILED payouts can be cancelled; cancelling an already cancelled payout returns it unchanged
List Scheduled Payouts
List scheduled payouts, including CUSTOM payouts that can be cancelled
Retrieve A Specific Scheduled Payout
Retrieve a specific scheduled payout by ID
Create A New Scheduled Payout
Create or update one CUSTOM scheduled payout, upserted by client and external_id
List Worker Change Fields
Returns a paginated list of worker change fields
List Worker Changes
Returns a paginated list of worker changes
Retrieve A Specific Worker Change
Retrieve a specific worker change
List Workers
Retrieves a list of workers with filtering, expansion, and sorting capabilities
Get Worker
Retrieves detailed information about a single worker by ID
List Worker Time Splits
Returns a paginated list of worker time splits
Retrieve A Specific Worker Time Split
Retrieve a specific worker time split
Create A New Worker Time Split
Create a new worker time split
Update A Worker Time Split
Update a specific worker time split
Delete A Worker Time Split
Delete a worker time split
List Workflows
List workflows
Retrieve A Workflow Execution
Returns a workflow execution’s current status
Retrieve A Workflow
Retrieve a workflow
Create A New Workflow Execution
Launches a new execution of the workflow’s current published version
Create A New Workflow
Create a workflow
Create A New Workflow Action Execution
Creates a workflow action execution
Update A Workflow
Update a workflow
Delete A Workflow
Delete a workflow
List Work Locations
Returns a paginated list of all work locations configured for the organization
Retrieve A Specific Work Location
Retrieves details for a specific work location by ID
Create A New Work Location
Create a new work location
Update A Work Location
Update a specific work location
Delete A Work Location
Delete a work location