Guides
Signup For Free

Rippling API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for Rippling API as part of the HRIS category

Delete Group

  • ID: delete_group
  • Operation: write
  • Entities: oauth application, group
  • Summary: The Delete Group API is used to delete a specified group within Rippling. This endpoint requires an OAuth application, intended for mapping third-party application 'Groups' within Rippling organizations. The request must include a bearer token in the Authorization header for authentication. The groupId path parameter is required and specifies the unique identifier for the group to be deleted. A successful response returns a status of 200 OK.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Active and Terminated Employees

  • ID: get_active_and_terminated_employees
  • Operation: read
  • Entities: department, manager, employee
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Active Employees List

  • ID: get_active_employees_list
  • Operation: read
  • Entities: department, work location, employee
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

GET Company Activity

  • ID: get_company_activity
  • Operation: read
  • Entities: company, event, group
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

GET Company Leave Types

  • ID: get_company_leave_types
  • Operation: read
  • Entities: leave, company leave type
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

GET Company Levels

  • ID: get_company_levels
  • Operation: read
  • Entities: company, level, position
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

GET Current Company

  • ID: get_current_company
  • Operation: read
  • Entities: work location, company, address
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Current Leave Requests

  • ID: get_current_leave_requests
  • Operation: read
  • Entities: leave policy, leave request, employee
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

GET Current User Information

  • ID: get_current_user_information
  • Operation: read
  • Entities: user, company, access token
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

GET Custom Fields

  • ID: get_custom_fields
  • Operation: read
  • Entities: company, custom field
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

GET Departments

  • ID: get_departments
  • Operation: read
  • Entities: department, company
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Information

  • ID: get_employee_information
  • Operation: read
  • Entities: department, manager, employee
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Employee Leave Balances

  • ID: get_employee_leave_balances
  • Operation: read
  • Entities: leave balance, company leave type, role
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

GET Group Details

  • ID: get_group_details
  • Operation: read
  • Entities: user, version, group
  • Summary: The GET Group Details API retrieves information about a specific group within Rippling using the unique groupId. The request requires an Authorization header with a bearer token for authentication. The path parameter groupId is mandatory to specify which group to retrieve. The response includes details such as the group's name, id, spokeId, version, and an array of user ids associated with the group.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Leave Balances for a Given Role

  • ID: get_leave_balances_for_a_given_role
  • Operation: read
  • Entities: leave balance, company leave type, role
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get SAML Metadata

  • ID: get_saml_metadata
  • Operation: read
  • Entities: token, saml metadata, app integration
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Teams List

  • ID: get_teams_list
  • Operation: read
  • Entities: team, company, employee
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Third-Party Groups for an Organization

  • ID: get_third_party_groups_for_an_organization
  • Operation: read
  • Entities: organization, user, group
  • Summary: This API endpoint retrieves the current third-party groups for an organization within Rippling. It requires an OAuth application for access, as it is intended for mapping third-party application 'Groups' within Rippling organizations. The request must include a bearer token in the Authorization header. The response is an array of group objects, each containing a unique id, a user-readable name, a spokeId (which is a unique string identifier), a version identifier, and an array of user ids associated with the group.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Work Locations

  • ID: get_work_locations
  • Operation: read
  • Entities: work location, company, address
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

PATCH Group

  • ID: patch_group
  • Operation: write
  • Entities: user, version, group
  • Summary: The PATCH Group API allows for updating specific fields of a group within Rippling organizations. It requires an OAuth application for authorization. The endpoint is used to map third-party application 'Groups' within Rippling. The PATCH method updates only the specified fields, leaving others unchanged. The request requires a bearer token in the Authorization header and includes path parameters for the groupId. The request body can include fields such as name, spokeId, users, and version. The response returns the updated group details, including id, spokeId, name, users, and version.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Leave Request

  • ID: patch_update_leave_request
  • Operation: write
  • Entities: leave policy, leave request, employee
  • Summary: 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'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Approve or Decline a Leave Request

  • ID: post_approve_or_decline_leave_request
  • Operation: write
  • Entities: manager, leave request, employee
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Generic Group

  • ID: post_create_generic_group
  • Operation: write
  • Entities: user, group
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Leave Request

  • ID: post_create_leave_request
  • Operation: write
  • Entities: leave policy, leave request, employee
  • Summary: The Create Leave Request API allows users to create a leave request for an employee. The API requires a bearer token for authorization and accepts various parameters in the request body, including the employee's role, leave status, start and end dates, and leave policy. The response includes a detailed leave request object with information such as the request ID, status, dates, and leave type. This endpoint is currently in alpha and should not be used by default. Only TILT managed requests can have a status other than PENDING.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Mark App as Installed in Rippling

  • ID: post_mark_app_installed
  • Operation: write
  • Entities: app
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Push New Candidate to Rippling Onboarding

  • ID: post_push_new_candidate_to_rippling_onboarding
  • Operation: write
  • Entities: department, attachment, candidate
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Group in Rippling

  • ID: put_update_group_in_rippling
  • Operation: write
  • Entities: user, group
  • Summary: 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.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 7 days ago