Rippling API Directory

Rippling is a versatile software platform that revolutionizes human resources and business operations management. It offers a comprehensive suite of tools designed to streamline and automate various aspects of employee management, making it an essential asset for businesses looking to enhance efficiency. Key functionalities include payroll management, which automates payroll processing, ensuring compliance and accuracy with tax calculations and filings across federal, state, and local agencies. Additionally, Rippling supports global payroll, enabling businesses to seamlessly pay employees worldwide, thus catering to the needs of international operations.

Beyond payroll, Rippling excels in HR management by providing tools for managing employee information, benefits administration, and ensuring compliance with HR regulations. Its IT management features allow businesses to manage employee devices, apps, and access permissions, effectively integrating IT management with HR processes. Furthermore, Rippling automates onboarding and offboarding processes, ensuring efficient setup and removal of employee access and tools. The platform also offers time tracking and attendance management features, helping businesses monitor and manage employee work hours efficiently. With its integrated solution, Rippling significantly streamlines administrative tasks and enhances operational efficiency in HR and IT management. For developers and businesses looking to extend these capabilities, the Rippling API offers seamless integration options, making it a powerful tool for customized business solutions.

Key highlights of Rippling APIs

• Automation of HR Functions
  • Automates tasks like employee onboarding, benefits management, and payroll processing, saving time and reducing errors.
• Centralized Benefits Management
  • Allows HR teams to manage employee benefits, such as health insurance and retirement plans, in one system, improving efficiency.
• Data Synchronization
  • Ensures up-to-date and consistent employee information across different systems.
• REST API Integration
  • Enables developers to integrate Rippling with other systems, allowing for customization to meet specific business needs.
• Seamless HR and IT Integration
  • Supports integration of HR and IT processes, enhancing employee experience by making processes faster and more efficient.
• Third-Party Integrations
  • Can be integrated with applications like 15Five to facilitate data exchange and improve workflow efficiency.

Rippling API Endpoints

Candidate Management

• POST https://api.rippling.com/platform/api/ats_candidates/push_candidate : This API endpoint allows applications integrating with OAuth2.0 to push a candidate from an applicant tracking system directly into the Rippling onboarding flow. The request requires a bearer token for authorization and includes candidate details such as name, email, job title, phone number, and other employment-related information. The response returns the same candidate details as confirmation of successful onboarding.

Company Information

• GET https://api.rippling.com/platform/api/companies/current : The GET Current Company API retrieves the currently accessible company for the given token. It requires an authorization token in the headers and returns details about the company, including its ID, address, work locations, primary email, phone number, and name. The response includes a company object with nested address and work location details.
• GET https://api.rippling.com/platform/api/company_activity : The GET Company Activity API retrieves the activity for a given company from Rippling. It supports pagination using a 'next' parameter to ensure no events are skipped or duplicated. The API requires an Authorization header with a bearer token and accepts query parameters such as 'endDate', 'limit', 'next', and 'startDate' to filter and paginate the results. The response includes a list of events and a pagination cursor for the next page. If an error occurs, an error message is returned.
• GET https://api.rippling.com/platform/api/company_leave_types : The GET Company Leave Types API retrieves the current company leave types from the Rippling platform. It requires an Authorization header with a bearer token for access. The response can be filtered using the 'managedBy' query parameter. The response includes an array of company leave request objects, each containing details such as the unique identifier, leave type key, name, description, and whether the leave type is unpaid.
• GET https://api.rippling.com/platform/api/custom_fields : The GET Custom Fields API retrieves the custom fields for a given company from Rippling. The request requires an Authorization header with a bearer token. Optional query parameters 'limit' and 'offset' can be used to control the number of returned values and their starting point, respectively. The response is an array of custom field objects, each containing an ID, type, title, and a boolean indicating if the field is mandatory. The type of custom fields can be one of several predefined values such as TEXT, DATE, NUMBER, etc.
• GET https://api.rippling.com/platform/api/departments : The GET Departments API retrieves a list of departments for a given company. It requires an Authorization header with a bearer token for access. The API supports optional query parameters 'limit' and 'offset' to control pagination of the returned department list. The response is an array of department objects, each containing a 'name', 'id', and 'parent' field, where 'parent' can be null if no parent department exists.
• GET https://api.rippling.com/platform/api/levels : The GET Company Levels API retrieves the levels for the company, which are predefined positions such as Manager or Executive. The request requires an Authorization header with a bearer token and accepts optional query parameters 'limit' and 'offset' to control pagination. The response returns an array of level objects, each containing a unique identifier, name, and an optional parent identifier.
• GET https://api.rippling.com/platform/api/teams : The Get Teams List API retrieves a list of teams for the company from Rippling. It requires an Authorization header with a bearer token for access. The API supports optional query parameters 'limit' and 'offset' to control the number of returned values and pagination. The response is an array of team objects, each containing an 'id', 'name', and 'parent' field, where 'parent' indicates if the team is a subteam within a larger team.
• GET https://api.rippling.com/platform/api/work_locations : The Get Work Locations API retrieves a list of work locations for a given company. The request requires an Authorization header with a bearer token and accepts optional query parameters 'limit' and 'offset' to control pagination. The response returns an array of work location objects, each containing details such as nickname and address, which includes fields like city, streetLine1, zip, country, state, and streetLine2.

Employee Management

• GET https://api.rippling.com/platform/api/employees : The Get Active Employees List API retrieves a list of active employees currently provisioned within the application. The response includes various details about each employee, such as their unique role ID, user ID, name, employment type, title, gender, department, work location, role state, and more. The API requires a bearer token for authorization, which should be included in the request headers. Optional query parameters 'limit' and 'offset' can be used for pagination, with a recommended maximum limit of 100. The response is an array of employee objects, each containing detailed information about the employee.
• GET https://api.rippling.com/platform/api/employees/include_terminated : The Get Active and Terminated Employees API endpoint retrieves a list of both active and terminated employees from the Rippling platform. It requires an Authorization header with a bearer token for access. The API supports pagination through 'limit' and 'offset' query parameters, with a maximum limit of 100. Additional query parameters include 'EIN' for the employer identification number and 'send_all_roles' to bypass access rules and retrieve all employees. The response includes detailed employee information such as ID, name, employment type, department, work location, role state, and more. The API is designed to provide comprehensive employee data for integrations and compliance purposes.
• GET https://api.rippling.com/platform/api/employees/{employeeId} : The Get Employee Information API retrieves detailed information about a specific employee identified by the employeeId path parameter. The request requires an Authorization header with a bearer token. The response includes comprehensive details about the employee, such as their name, employment type, work location, role state, and more. The API provides a structured response with fields like id, name, employmentType, gender, department, workLocation, and customFields, among others.

Leave Management

• GET https://api.rippling.com/platform/api/leave_balances : This API retrieves the leave balances for employees. It requires an Authorization header with a bearer token for access. The API supports optional query parameters 'limit' and 'offset' to control pagination. The response includes an array of roles, each containing a list of leave balances. Each balance entry specifies the company leave type, whether the balance is unlimited, and the remaining balance in minutes with and without future leave requests considered.
• GET https://api.rippling.com/platform/api/leave_balances/{role} : This API retrieves the leave balances for a given role, where a role represents a single employee. The request requires a bearer token for authorization, provided in the Authorization header. The role ID, which is a path parameter, uniquely identifies the employee. The response includes the role ID and an array of leave balances, each with details such as the company leave type ID, whether the balance is unlimited, and the remaining balance in minutes with and without future leave requests considered.
• GET https://api.rippling.com/platform/api/leave_requests : This API retrieves the current leave requests from the Rippling platform. It allows filtering by various query parameters such as endDate, startDate, status, and more. The request requires an Authorization header with a bearer token. The response includes detailed information about each leave request, such as the employee's role, status, dates, and the system managing the leave request.
• PATCH https://api.rippling.com/platform/api/leave_requests/{id} : The Update Leave Request API allows users to modify an existing leave request by providing the unique identifier of the leave request in the path parameters. The request requires an Authorization header with a bearer token for authentication. The body of the request can include various fields such as 'requestedBy', 'status', 'startDate', 'endDate', 'startDateStartTime', 'endDateEndTime', 'startDateCustomHours', 'endDateCustomHours', and 'reasonForLeave'. The response returns a detailed leave request object, including fields like 'id', 'createdAt', 'updatedAt', 'role', 'roleName', 'requestedBy', 'requestedByName', 'status', 'startDate', 'endDate', 'startDateStartTime', 'endDateEndTime', 'startDateCustomHours', 'endDateCustomHours', 'comments', 'numHours', 'numMinutes', 'leavePolicy', 'leaveTypeUniqueId', 'policyDisplayName', 'reasonForLeave', 'processedAt', 'processedBy', 'processedByName', 'roleTimezone', 'dates', 'managedBy', and 'partialDays'.
• POST https://api.rippling.com/platform/api/leave_requests/{id}/process : This API allows an admin or manager to approve or decline a pending leave request. The request requires a bearer token for authorization and includes a path parameter for the leave request ID and a query parameter for the action (approve or decline). The response includes detailed information about the leave request, such as the employee's role, status, dates, and whether the leave is paid.

Group Management

• POST https://api.rippling.com/platform/api/groups : This API endpoint allows the creation of a generic group that can be associated within a third-party application. The request requires a bearer token for authorization, and the body must include a name, a unique spokeId, and an array of user IDs. Upon successful creation, the API returns the group's unique identifier, name, spokeId, user IDs, and version.
• PUT https://api.rippling.com/platform/api/groups/{groupId} : The 'Update Group in Rippling' API allows third-party applications to update all fields of a group within Rippling organizations using the PUT method. The endpoint requires an OAuth application for authorization. The request must include a bearer token in the Authorization header. The groupId path parameter is required to specify the unique identifier of the group. The request body can include optional fields such as name, spokeId, users, and version to update the group's details. The response returns the updated group details, including the id, spokeId, name, users, and version.

Application Management

• POST https://api.rippling.com/platform/api/mark_app_installed : This API endpoint is used to mark an app as installed in Rippling. It is a POST request to the URL 'https://api.rippling.com/platform/api/mark_app_installed'. The request requires an Authorization header with a bearer token, and the headers 'Accept' and 'Content-Type' set to 'application/json'. The response returns a JSON object with a boolean 'ok' field indicating whether the app was successfully marked as installed. No request body is required.

User Information

• GET https://api.rippling.com/platform/api/me : The GET Current User Information API retrieves basic information about the Rippling user whose access token is being used. This API is typically used in the SSO flow. The request requires an Authorization header with a bearer token. The response includes the user's unique identifier, work email, and the unique identifier of the company.
• GET https://api.rippling.com/platform/api/saml/idp_metadata : The Get SAML Metadata API endpoint provides a SAML IDP metadata file for the current app integration. This endpoint is accessible only with a token associated with an app integration that has SAML enabled. The metadata is unique per customer app installation and changes with each new installation. To access this endpoint, include your bearer token in the Authorization header. The response is an XML string containing the SAML metadata. If the token is invalid or the app does not have SAML enabled, a 404 error is returned.

‍

Rippling API FAQs

1. How do I access the Rippling API?

• Answer: To access the Rippling API, you need to generate an API token. Navigate to the 'API Tokens' section in your Rippling account settings, create a new token, and securely store it, as it will not be displayed again.
• Source: API Tokens - Rippling

‍

2. What authentication method does the Rippling API use?

• Answer: The Rippling API uses token-based authentication. Include the API token in the 'Authorization' header of your HTTP requests, formatted as 'Bearer YOUR_API_TOKEN'.
• Source: Rippling Platform API

‍

3. Are there rate limits for the Rippling API?

• Answer: Yes, the Rippling API enforces rate limits to ensure fair usage. While specific limits are not publicly documented, it's recommended to implement error handling for potential 429 Too Many Requests responses.
• Source: Rippling API - Developer docs, APIs, SDKs, and auth.

‍

4. Can I retrieve employee data using the Rippling API?

• Answer: Yes, you can retrieve employee data by making a GET request to the '/employees' endpoint. Ensure you have the necessary permissions and that your API token has access to the required scopes.
• Source: Rippling Platform API

‍

5. Does the Rippling API support webhooks?

• Answer: Yes, the Rippling API supports webhooks, allowing you to receive real-time notifications for specific events. You can configure webhooks to trigger on events such as employee onboarding or offboarding.
• Source: Rippling API - Developer docs, APIs, SDKs, and auth.

‍

Get Started with Rippling API Integration

For quick and seamless integration with Rippling API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Rippling API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Rippling API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍