Skip to main content

Rippling

Rippling is an all-in-one workforce management platform unifying HR, payroll, benefits, time tracking, IT, and finance in one system. It automates the full employee lifecycle from onboarding through offboarding, with a centralized data model connecting workers, departments, compensation, legal entities, and locations. Its REST and Platform APIs sync workforce data with warehouses and business applications.

Rippling icon

Power end-to-end data operations for your Rippling API with Nexla. Our bi-directional Rippling connector is purpose-built for Rippling, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Rippling or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Rippling workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

To connect Nexla to Rippling, you need a Rippling API token with the appropriate scopes for the data you want to access. API tokens are generated in Rippling's Company Settings by a Rippling administrator.

Rippling API Surfaces

Rippling provides two API surfaces that Nexla uses:

  • REST API (rest.ripplingapis.com): The primary Rippling API for workforce data, including workers, departments, teams, compensations, legal entities, work locations, users, job requisitions, candidates, time entries, and custom objects. Uses Bearer token authentication and cursor-based (next_link) pagination.

  • Platform API (api.rippling.com/platform/api): An earlier API surface covering employees, leave requests, leave balances, leave types, custom fields, and company activity. Uses the same Bearer token with offset-based pagination.

Both API surfaces use the same API token. The scopes you assign to the token determine which endpoints are accessible.

Obtain a Rippling API Token

Rippling API tokens are generated from Company Settings in the Rippling admin console. Only administrators with the appropriate permissions can create API tokens.

  1. Sign in to your Rippling account as an administrator.

  2. Navigate to Company Settings in the left navigation panel.

  3. Select API Access from the settings menu. This section displays all existing API keys and provides controls for creating new ones.

  4. Click Create API Key to open the token creation form.

  5. Enter a descriptive name for the API key (for example, Nexla Integration) so it can be identified later.

  6. Assign the required scopes to the token. Scopes control which Rippling data the token can access. Select the scopes that correspond to the Rippling data you intend to use in Nexla:

    • Workers data (List Workers, Get Worker by ID): workers:read

    • Departments (List Departments): departments:read

    • Teams (List Teams): teams:read

    • Compensations (List Compensations): compensations:read

    • Legal Entities (List Legal Entities): legal_entities:read

    • Work Locations (List Work Locations): work_locations:read

    • Users (List Users): users:read

    • Job Requisitions (List Job Requisitions): job_requisitions:read

    • Candidates and Applications (List Candidates, List Candidate Applications): candidates:read

    • Time Entries (List Time Entries): time_entries:read

    • Custom Objects (List Custom Objects, List Custom Object Records): custom_objects:read

    • Employees — Platform API (List Employees): included with standard employee read access

    • Leave — Platform API (List Leave Requests, Leave Balances, Leave Types): leave:read; note that leave data requires Rippling's Time & Attendance module to be enabled for the company

    • Company Activity — Platform API (Get Company Activity): company_activity:read

    You can only grant scopes that your own Rippling permission profile includes. If a required scope is not available in the token creation form, contact your Rippling administrator to ensure your account has the corresponding permissions before generating the token.

  7. Click Save to generate the token.

  8. Copy the generated API token immediately and store it securely. The token value is only displayed once and cannot be retrieved again after you close the creation dialog.

Important

Rippling API tokens expire after 30 days of inactivity. If a Nexla flow using this credential stops receiving data, verify that the token has not expired and regenerate it from Company Settings > API Access if necessary.

For additional information about API tokens and scopes, refer to the Rippling API Tokens and Permissions guide.

Authenticate

Credentials required

Authenticate using a Rippling API token from Company Settings > API Access. Token is passed as a Bearer token.

FieldRequiredSecretDescription
API TokenYesYesBearer token generated in Rippling Company Settings > API Access. Assign required read scopes per endpoint category.

Create a credential in Nexla

  1. To create a new Rippling credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter the Rippling API token you generated in the API Token field. The token is transmitted as a Bearer token in the Authorization header of every API request Nexla makes to Rippling. This field is required and stored securely in encrypted form.

    The credential is validated against the Rippling REST API upon saving. If validation fails, verify that the token was copied in full and that the token includes at least users:read scope, which is used for the connection test.

  4. Click the Save button at the bottom of the overlay to save the configured credential. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Rippling connector tile, then select the credential that will be used to connect to the Rippling instance, and click Next; or, create a new Rippling credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Rippling endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Workers

Returns all workers—both active and terminated—from the Rippling REST API with expanded fields for organizational context, compensation, and location. This is the primary endpoint for syncing your full workforce roster into Nexla and is useful for HR reporting, headcount analysis, and organizational mapping.

  • This endpoint uses cursor-based pagination via the next_link field and automatically fetches all pages until the complete worker list is retrieved. No manual pagination configuration is required.
  • Optionally, adjust the Page Size field to control how many records are retrieved per API call. The default value is 100, which is also the maximum allowed by the Rippling API. Reducing this value may be useful when troubleshooting network timeouts on large worker sets.

Each worker record includes expanded fields for the associated user account, manager, department, legal entity, employment type, compensation, team, and work location. This makes the List Workers endpoint well-suited for creating a comprehensive employee directory or org-chart data feed.

Get Worker by ID

Retrieves a single worker record from the Rippling REST API using the worker's unique Rippling ID. Use this endpoint when you need to look up detailed information for a specific employee, such as during event-driven data flows or targeted enrichment pipelines.

  • Enter the Rippling worker's unique identifier in the Worker ID field. This is a required parameter. Worker IDs can be obtained from the List Workers endpoint response—each worker record includes a unique id field that serves as the identifier for this endpoint.

  • The response includes all expanded fields for the specified worker, including user, manager, department, legal entity, employment type, compensation, team, and location.

List Departments

Returns all company departments from the Rippling REST API using cursor-based pagination. Use this endpoint to build department reference tables, populate org-chart structures, or enrich worker records with department metadata in downstream systems.

  • This endpoint uses cursor-based (next_link) pagination and automatically fetches all pages until the complete department list is retrieved.
  • Optionally, adjust the Page Size field to control how many department records are returned per API call. The default value is 100, which is also the maximum.

List Teams

Returns all teams for the company from the Rippling REST API. Teams are a grouping layer within Rippling that can cut across departments, and this endpoint is useful for building team-level reporting or identifying cross-functional group membership.

  • This endpoint requires the teams:read scope on your Rippling API token. Verify that this scope was assigned when you generated the token.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

List Employment Types

Returns all employment types configured for your company from the Rippling REST API, such as full-time, part-time, contractor, and temporary classifications. This endpoint is useful for populating reference tables and building workforce composition analytics.

  • This endpoint uses cursor-based pagination and returns all employment type records configured by your organization.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

List Compensations

Returns worker compensation records from the Rippling REST API, including pay rate, currency, and pay period information. Use this endpoint for compensation benchmarking, payroll analytics, or syncing pay data to a data warehouse.

  • This endpoint requires the compensations:read scope on your Rippling API token. Compensation data is sensitive—ensure that access is restricted to authorized Nexla users and that the resulting Nexset is appropriately protected.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

Compensation data in Rippling is subject to your organization's access control policies. Verify that the API token used has been granted the compensations:read scope by an administrator with appropriate permissions.

List Legal Entities

Returns all legal entities registered by your company in Rippling, including employer identification number (EIN), address, and jurisdiction details. This endpoint is useful for multi-entity organizations that need to map workers to their respective legal employer.

  • This endpoint uses cursor-based pagination and returns all legal entity records associated with your Rippling account.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

List Work Locations

Returns all company work locations from the Rippling REST API with full address details. Use this endpoint to build location reference data, support tax jurisdiction mapping, or populate remote/in-office classification analytics.

  • This endpoint uses cursor-based pagination and returns all work location records configured in your Rippling account.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

List Users

Returns all Rippling user accounts for your company, including login status and access state information. Use this endpoint to audit which employees have active Rippling access or to synchronize user account data with identity management systems.

  • This endpoint requires the users:read scope and uses cursor-based pagination via next_link.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

List Tracks and Levels

Returns career tracks and levels for worker classification from the Rippling REST API. Tracks and levels define the career ladder structure within your organization and are useful for performance management reporting and compensation band analysis.

  • This endpoint uses cursor-based pagination and returns all track and level records configured for your company.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

List Job Requisitions

Returns open and closed job requisitions from the Rippling REST API. This endpoint is useful for applicant tracking system (ATS) reporting, headcount planning analysis, and tracking recruiting pipeline velocity.

  • This endpoint uses cursor-based pagination via next_link and returns all job requisitions regardless of status.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

List Candidates

Returns candidates who have applied to your company's job requisitions via the Rippling ATS. Use this endpoint for recruiting pipeline reporting, time-to-hire analysis, and sourcing attribution analytics.

  • This endpoint uses cursor-based pagination and returns all candidate records associated with your company's job requisitions.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

List Candidate Applications

Returns candidate applications linked to job requisitions, including pipeline stage data. Use this endpoint to track application progress through the recruiting funnel, analyze stage conversion rates, or identify bottlenecks in your hiring process.

  • This endpoint uses cursor-based pagination and returns all candidate application records with their associated pipeline stage information.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

Get Current Company

Returns the company record associated with the current API token, including company address and work location details. This endpoint is useful as a reference lookup to retrieve your company's Rippling metadata without requiring any additional parameters.

  • This is a static (non-paginated) endpoint that returns the company record in a single API call. No additional configuration parameters are required beyond selecting this endpoint template.

List Employees (Platform API)

Returns active and terminated employees via the Rippling Platform API using offset-based pagination. This endpoint includes custom HR fields and role state information that may not be available through the REST API workers endpoint, making it valuable for custom field reporting and compliance use cases.

  • This endpoint uses offset-based pagination and automatically increments the offset until all employee records are retrieved.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

The List Employees endpoint accesses the Platform API (api.rippling.com/platform/api), which is a separate API surface from the primary REST API. Both surfaces use the same Bearer token, so no additional credentials are required.

List Leave Requests (Platform API)

Returns leave requests for all employees from the Rippling Platform API. Results can be filtered by date range and approval status. This endpoint requires Rippling's Time & Attendance module and Tier 2 API access to be enabled for your company.

  • Enter the Start Date and End Date to define the date range for leave requests. Dates must be in yyyy-MM-dd format. The default values are {now-90} for Start Date and {now} for End Date, which returns leave requests from the past 90 days through the current date.

  • Select the approval Status to filter results. Available options are:

    • All (default): Returns leave requests in any approval state.
    • Pending: Returns only leave requests awaiting approval.
    • Approved: Returns only approved leave requests.
    • Declined: Returns only declined leave requests.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

This endpoint requires Rippling's Time & Attendance module to be enabled for your company and the leave:read scope on your API token. Contact your Rippling administrator if this endpoint returns an authorization error.

List Leave Balances (Platform API)

Returns PTO and leave balances per employee from the Rippling Platform API, including remaining balance in minutes and an unlimited leave flag. Use this endpoint for leave liability reporting or to surface real-time accrual balances in downstream HR dashboards.

  • This endpoint uses offset-based pagination and automatically increments the offset until all leave balance records are retrieved.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

List Leave Types (Platform API)

Returns all company-configured leave types from the Rippling Platform API, such as PTO, sick leave, parental leave, and other custom leave categories. Use this endpoint to build leave type reference tables or to understand which leave policies your organization has configured in Rippling.

  • This is a static (non-paginated) endpoint that returns all leave types in a single API call. No additional configuration parameters are required beyond selecting this endpoint template.

List Custom Fields (Platform API)

Returns company custom HR field definitions from the Rippling Platform API. Custom fields are organization-specific data points added to employee records beyond Rippling's standard fields. Use this endpoint to discover and document the custom field schema before ingesting custom field values via the List Employees endpoint.

  • This endpoint uses offset-based pagination and returns all custom field definition records.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

Get Company Activity (Platform API)

Returns an audit log of company-level events from the Rippling Platform API, filtered by a date range. Use this endpoint for compliance reporting, security auditing, or tracking administrative changes made in Rippling over time.

  • Enter the Start Date and End Date to define the date range for the audit log. Dates must be in yyyy-MM-dd format. The default values are {now-30} for Start Date and {now} for End Date, which returns the past 30 days of activity.

  • This endpoint uses cursor token-based pagination and automatically fetches all pages of events within the specified date range.
  • Optionally, adjust the Page Size field to control how many activity events are returned per API call. The default value is 100.

This endpoint requires the company_activity:read scope on your Rippling API token. For large date ranges with high activity volume, consider narrowing the date range to reduce API response times.

List Time Entries

Returns time entries from the Rippling REST API filtered by a date range. Use this endpoint to sync time tracking data for payroll reconciliation, labor cost analysis, or workforce productivity reporting.

  • Enter the Start Date and End Date to define the date range for time entries. Dates must be in yyyy-MM-dd format. The default values are {now-30} for Start Date and {now} for End Date, returning the past 30 days of time entries.

  • This endpoint uses cursor-based (next_link) pagination and automatically fetches all pages within the specified date range.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

Time entry data requires Rippling's Time & Attendance module. Verify that your company has this module enabled and that your API token includes the time_entries:read scope.

List Custom Objects

Returns custom object definitions from the Rippling REST API. Custom objects extend Rippling's data model with organization-specific entities beyond the standard HR objects. Use this endpoint to discover what custom objects have been defined in your Rippling account before fetching their records.

  • This endpoint uses cursor-based pagination and returns all custom object definition records.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

List Custom Object Records

Returns data rows for a specific custom object by its API name from the Rippling REST API. Use this endpoint after using the List Custom Objects endpoint to identify the custom object you want to query, and then fetch its associated records for use in downstream reporting or data enrichment.

  • Enter the API name of the custom object whose records you want to retrieve in the Custom Object API Name field. This is a required parameter. The API name for each custom object can be found using the List Custom Objects endpoint—each object definition includes an apiName field that should be used here.

  • This endpoint uses cursor-based pagination and automatically fetches all record pages for the specified custom object.
  • Optionally, adjust the Page Size field. The default and maximum value is 100 records per page.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Rippling data sources can also be manually configured to ingest data from any valid Rippling REST or Platform API endpoint not covered by the pre-built templates, including chained API calls or custom query parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Rippling provides two API base URLs: the REST API at https://rest.ripplingapis.com/{endpoint} (workers, departments, teams, compensations, legal entities, work locations, users, job requisitions, candidates, time entries, custom objects) and the Platform API at https://api.rippling.com/platform/api/{endpoint} (employees, leave data, custom fields, company activity). Both surfaces use the same API token.

Rippling REST API list responses wrap results in a results array—enter $.results[*] in Set Path to Data in Response, or $ for single-object responses such as Get Worker by ID. Rippling Platform API responses are typically a flat array ($[*]), except endpoints such as Company Activity that use a response envelope ($.events[*]).

Date/time macros are useful for Rippling endpoints that accept startDate and endDate query parameters, such as time entries, leave requests, and company activity; use the yyyy-MM-dd date format. The Authorization header is added automatically from the credential and does not need to be set manually.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Rippling data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Rippling destination, and select the Send to Destination option from the menu. Select the Rippling connector from the list of available destination connectors, then select the credential that will be used to connect to the Rippling organization, and click Next; or, create a new Rippling credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Rippling endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Leave Request

Submits a new leave request for a worker via the Rippling Platform API. Use this endpoint to programmatically create leave requests from external systems—for example, when automating leave management as part of an HR onboarding or scheduling workflow.

  • This endpoint uses an HTTP POST to https://api.rippling.com/platform/api/leave_requests. The request body is automatically constructed from the Nexset data in JSON format.
  • The request payload must include the following fields in the Nexset data being sent to this destination:

    • Role ID: The Rippling role ID of the worker for whom the leave request is being submitted. This corresponds to the worker's unique identifier in Rippling's HRIS system.
    • Leave Type ID: The ID of the leave type to apply (e.g., PTO, sick, parental). Use the List Leave Types endpoint to retrieve available leave type IDs for your company.
    • Start Date: The first day of the requested leave period, in yyyy-MM-dd format.
    • End Date: The last day of the requested leave period, in yyyy-MM-dd format.
  • No additional template-level parameters are required. All fields are passed as part of the Nexset data JSON body.

Creating leave requests via the API requires that Rippling's Time & Attendance module is enabled for your company and that your API token includes the leave:write scope. The leave request will be created in a pending state and may require manager approval depending on your company's leave approval policy.

Update Leave Request

Updates an existing leave request by its unique ID via the Rippling Platform API using an HTTP PATCH request. Use this endpoint to modify leave request dates, hours, reason, or status from an external system as part of an automated HR workflow.

  • Enter the unique ID of the leave request to update in the Leave Request ID field. This is a required parameter. Leave request IDs can be retrieved using the List Leave Requests source endpoint. The ID is appended to the Platform API URL path to target the specific leave record.

  • The request body is automatically constructed from the Nexset data in JSON format. Include only the fields you want to modify—the PATCH method applies partial updates, so omitted fields retain their current values in Rippling.
  • Fields that can be updated via PATCH include:

    • Start Date: Updated start date for the leave period, in yyyy-MM-dd format.
    • End Date: Updated end date for the leave period, in yyyy-MM-dd format.
    • Hours: Updated leave duration in hours.
    • Reason: Updated reason or notes for the leave request.
    • Status: Updated approval status, where applicable.

Only leave requests in an editable state can be updated via the API. Approved or finalized leave requests may be locked for editing depending on your company's Rippling configuration. Verify that the leave request is in a modifiable state before sending an update payload.

Manual configuration

Rippling destinations can also be manually configured to send data to any valid Rippling REST or Platform API endpoint not covered by the pre-built templates. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Rippling accepts JSON for all write operations. For update operations (PATCH/PUT), include the unique ID of the record to be updated at the end of the URL path—for example, https://api.rippling.com/platform/api/leave_requests/{leave_request_id}. The Authorization and Content-Type headers are added automatically and do not need to be set manually.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To activate data delivery to Rippling, open the destination resource menu and select Activate.

Data will not be sent to Rippling until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.