Skip to main content

Rippling Data Source

The Rippling connector enables you to ingest workforce data—including workers, employees, departments, compensation records, leave requests, time entries, and audit activity—from your Rippling account into Nexla. Follow the instructions below to create a new data flow that ingests data from a Rippling source in Nexla.
rippling_api.png

Rippling

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Rippling connector tile from the list of available connectors. 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.

  3. In Nexla, Rippling data sources can be created using pre-built endpoint templates, which expedite source setup for common Rippling endpoints. Each template is designed specifically for the corresponding Rippling endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Rippling sources can also be configured manually, allowing you to ingest data from Rippling endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Rippling endpoints. Each template is designed specifically for the corresponding Rippling endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • 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. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

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.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Rippling data sources can be manually configured to ingest data from any valid Rippling REST or Platform API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Rippling sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom query parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Rippling API from the Method pulldown menu. The most common method for Rippling data ingestion is:

    • GET: For retrieving data from the Rippling REST or Platform API. All pre-built Rippling endpoint templates use GET requests.

API Endpoint URL​

  1. Enter the URL of the Rippling API endpoint from which this source will fetch data in the Set API URL field. Rippling provides two base URLs:
    • REST API: https://rest.ripplingapis.com/{endpoint} — for workers, departments, teams, compensations, legal entities, work locations, users, job requisitions, candidates, time entries, and custom objects.
    • Platform API: https://api.rippling.com/platform/api/{endpoint} — for employees, leave data, custom fields, and company activity.

Ensure the API endpoint URL is correct and accessible with your current API token. You can verify the endpoint URL by referencing the Rippling REST API reference or the Rippling Platform API reference.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is particularly useful for Rippling endpoints that support date-range filtering, such as time entries, leave requests, and company activity.

Macros are particularly useful for Rippling endpoints that accept startDate and endDate query parameters, enabling you to automatically retrieve only data from recent periods rather than fetching the full history on every run.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-30) to indicate the datetime 30 time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. Rippling date-range parameters use the format yyyy-MM-dd.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-30}, when Day is selected, {now-30} will be converted to the date 30 days before the current date.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. This is useful for Rippling endpoints that require a specific ID in the URL path—for example, using a worker ID retrieved from a List Workers source to call the Get Worker by ID endpoint dynamically.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list.

Path to Data​

Optional

If only a subset of the data returned by the API endpoint is needed, you can designate the part of the response that should be included in the Nexset(s) produced from this source. This is important for Rippling endpoints, which wrap their results in a JSON response envelope.

For Rippling REST API endpoints, the results array is typically located at $.results[*]. For Rippling Platform API endpoints, the results are typically a top-level array, so $[*] is the appropriate path. For endpoints that return a single object (such as Get Worker by ID), use $ to capture the entire response.

Path to Data is essential for Rippling API responses, which wrap returned records in a results array (REST API) or return a flat array (Platform API). Without specifying the correct path, Nexla may not properly parse individual records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For Rippling REST API endpoints (paginated list responses), enter: $.results[*]

    • For Rippling REST API endpoints (single object responses), enter: $

    • For Rippling Platform API endpoints (flat array responses), enter: $[*]

    • For Rippling Platform API endpoints that return a different envelope (such as company activity), enter the appropriate path—for example, $.events[*] for the Company Activity endpoint.

    Path to Data Example:

    For the List Workers endpoint response, the worker records are located in a top-level results array. Enter $.results[*] to instruct Nexla to treat each element of that array as an individual worker record.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. Rippling REST API responses include fields such as next_link and pagination metadata alongside the results array—these can be captured as metadata if needed.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field using JSON path notation.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization header—this is handled automatically by the Rippling credential. The Accept: application/json header is also added automatically by all Rippling endpoint templates and should not need to be re-added manually.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, 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.