Rippling Component

Rippling makes it easy to manage your company's Payroll, Benefits, HR, and IT—all in one, modern platform.

Component key: rippling

Changelog ↓

Description

Rippling makes it easy to manage your company's Payroll, Benefits, HR, and IT—all in one, modern platform.

Connections

OAuth 2.0

key: authorizationCode

To authenticate with Rippling using OAuth 2.0, create and deploy an App Listing in the Rippling partner company dashboard. Refer to the Developer Portal documentation for detailed guidance, including the Partner Requirements and Installation OAuth Guide.

Prerequisites

A Rippling partner account (apply via Partner Requirements)
Access to the partner company dashboard at app.rippling.com

Setup Steps

Log in to the Rippling partner company at app.rippling.com and navigate to Partner > Client Command Center
Create an App Listing with the following configuration:
- Set the Redirect URI to: https://oauth2.prismatic.io/callback
- Note the Authorization URL (typically in the format https://app.rippling.com/apps/PLATFORM/{AppName})
Deploy the App Listing (sandbox first for testing)
Retrieve the Client ID and Client Secret from the deployed App Listing
Determine the required scopes for the integration (space-delimited values like employees:read departments:read)

Configure the Connection

Enter the Client ID and Client Secret from the deployed App Listing
Enter the Authorization URL from step 2
For Scopes, enter the space-delimited scopes determined in step 5. Refer to Rippling's scopes documentation for available scope values
The Token URL is automatically set to https://app.rippling.com/api/o/token/ and does not require modification

Input	Notes	Example
Authorization URL	The OAuth 2.0 authorization URL for your Rippling app. Replace {AppName} with your actual app name. Learn more	https://app.rippling.com/apps/PLATFORM/YourAppName
Client ID	The OAuth 2.0 client ID for your Rippling partner app. Found in your app configuration in the Rippling admin console.
Client Secret	The OAuth 2.0 client secret for your Rippling partner app. Keep this value secure and do not share it.
Scopes	Space-separated list of OAuth permission scopes. Scopes are configured in your Rippling app settings and determine which resources your integration can access.	employees:read departments:read teams:read
Token URL	The OAuth 2.0 token URL for Rippling's API.	https://app.rippling.com/api/o/token/

Bearer API Key

key: bearerApiKey

To authenticate with Rippling using a bearer API key, generate an API key from the Rippling admin console and enter it into the connection configuration.

Prerequisites

Access to the Rippling admin console
Authority to generate API keys

Setup Steps

To generate an API key:

Navigate to the Rippling admin console
Open the Settings or API section
Locate the API Keys area
Click Generate New API Key or Create API Key
Copy the generated API key value

note

The API key is used for authenticating API requests on behalf of the organization. Keep the API key secure and do not share it publicly.

Configure the Connection

Enter the API key into the API Key field in the connection configuration

Refer to Rippling's API documentation for additional information on API key management and API authentication.

Verify Connection

After saving the connection, the API key is ready for use in integration actions.

Input	Notes	Example
API Key	API key from the Rippling admin console. Navigate to <strong>Admin > Settings > API</strong> in Rippling to generate your API key. Learn more

Data Sources

Select Business Partner Group

Select a business partner group from your Rippling account. | key: selectBusinessPartnerGroup | type: picklist

Input	Notes	Example
Connection	The Rippling connection to use.

Select Department

Select a department from your Rippling account. | key: selectDepartment | type: picklist

Input	Notes	Example
Connection	The Rippling connection to use.

Select Employment Type

Select an employment type from your Rippling account. | key: selectEmploymentType | type: picklist

Input	Notes	Example
Connection	The Rippling connection to use.

Select Job Function

Select a job function from your Rippling account. | key: selectJobFunction | type: picklist

Input	Notes	Example
Connection	The Rippling connection to use.

Select Object Category

Select an object category from your Rippling account. | key: selectObjectCategory | type: picklist

Input	Notes	Example
Connection	The Rippling connection to use.

Select Supergroup

Select a supergroup from your Rippling account. | key: selectSupergroup | type: picklist

Input	Notes	Example
Connection	The Rippling connection to use.

Select Team

Select a team from your Rippling account. | key: selectTeam | type: picklist

Input	Notes	Example
Connection	The Rippling connection to use.

Select User

Select a user from your Rippling account. | key: selectUser | type: picklist

Input	Notes	Example
Connection	The Rippling connection to use.

Select Work Location

Select a work location from your Rippling account. | key: selectWorkLocation | type: picklist

Input	Notes	Example
Connection	The Rippling connection to use.

Select Worker

Select a worker from your Rippling account. | key: selectWorker | type: picklist

Input	Notes	Example
Connection	The Rippling connection to use.

Actions

Create Business Partner (V2)

Create a new business partner. | key: createBusinessPartner

Input	Notes	Example
Business Partner Group ID	The unique identifier of the business partner group to associate with.	bpg_abc123xyz
Connection	The Rippling connection to use.
Worker ID	The ID of the worker to associate with the business partner.	wkr_abc123xyz

{
  "data": {
    "id": "bp_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "business_partner_group_id": "bpg_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "worker_id": "wkr_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "client_group_id": null,
    "client_group_member_count": 0
  }
}

Create Business Partner Group (V2)

Create a new business partner group. | key: createBusinessPartnerGroup

Input	Notes	Example
Connection	The Rippling connection to use.
Default Business Partner ID	The unique identifier of the default business partner for this group.	bp_abc123xyz
Name	The name of the business partner group.	Engineering Department

{
  "data": {
    "id": "bpg_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2024-01-10T09:00:00Z",
    "updated_at": "2024-01-10T09:00:00Z",
    "name": "IT Business Partners",
    "domain": "IT",
    "default_business_partner_id": null
  }
}

Create Custom Object (V2)

Create a new custom object. | key: createCustomObject

Input	Notes	Example
Category	The category for the custom object.	Operations
Connection	The Rippling connection to use.
Description	A description of the custom object.	Department responsible for product development and technical infrastructure
Name	The name of the custom object.	Engineering Department

{
  "data": {
    "id": "co_02H5K8N2X3Y4Z5A6B7C8D9E0F2",
    "created_at": "2024-01-15T00:00:00Z",
    "updated_at": "2024-01-15T00:00:00Z",
    "name": "Training Record",
    "description": "Employee training and certification records",
    "api_name": "training_record",
    "category": "HR",
    "plural_label": "Training Records"
  }
}

Create Object Category (V2)

Create a new object category. | key: createObjectCategory

Input	Notes	Example
Connection	The Rippling connection to use.
Description	A description of the object category.	Department responsible for product development and technical infrastructure
Name	The name of the object category.	Engineering Department

{
  "data": {
    "id": "oc_03H5K8N2X3Y4Z5A6B7C8D9E0F3",
    "name": "Finance",
    "description": "Finance department objects"
  }
}

Delete Business Partner (V2)

Delete a business partner by ID. | key: deleteBusinessPartner

Input	Notes	Example
Connection	The Rippling connection to use.
Business Partner ID	Unique identifier for the business partner to delete.	bp_abc123xyz

{
  "data": {
    "success": true,
    "message": "Business partner bp_01H5K8N2X3Y4Z5A6B7C8D9E0F1 deleted successfully."
  }
}

Delete Business Partner Group (V2)

Delete a business partner group by ID. | key: deleteBusinessPartnerGroup

Input	Notes	Example
Connection	The Rippling connection to use.
Business Partner Group ID	Unique identifier for the business partner group to delete.	bpg_abc123xyz

{
  "data": {
    "success": true,
    "message": "Business partner group bpg_01H5K8N2X3Y4Z5A6B7C8D9E0F1 deleted successfully."
  }
}

Delete Custom Object (V2)

Delete a custom object by API name. | key: deleteCustomObject

Input	Notes	Example
Connection	The Rippling connection to use.
Custom Object API Name	The API name of the custom object to delete.	CustomProject__c

{
  "data": {
    "success": true,
    "message": "Custom object equipment_assignment deleted successfully."
  }
}

Delete Groups Group Id (V1)

DELETE Group. | key: deleteGroupsGroupId

Input	Notes	Example
Connection	The Rippling connection to use.
Group ID	The unique identifier for the group in Rippling.	12345

{
  "data": null
}

Delete Object Category (V2)

Delete an object category by ID. | key: deleteObjectCategory

Input	Notes	Example
Connection	The Rippling connection to use.
Object Category ID	Unique identifier for the object category to delete.	cat_abc123xyz

{
  "data": {
    "success": true,
    "message": "Object category oc_01H5K8N2X3Y4Z5A6B7C8D9E0F1 deleted successfully."
  }
}

Get Business Partner (V2)

Retrieve a specific business partner by ID. | key: getBusinessPartner

Input	Notes	Example
Connection	The Rippling connection to use.
Expand	Comma-separated fields to expand: business_partner_group, worker, client_group.	business_partner_group,worker,client_group
Business Partner ID	The unique identifier for the business partner.	bp_abc123xyz

{
  "data": {
    "id": "bp_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "business_partner_group_id": "bpg_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "worker_id": "wkr_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "client_group_id": "grp_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "client_group_member_count": 25
  }
}

Get Business Partner Group (V2)

Retrieve a specific business partner group by ID. | key: getBusinessPartnerGroup

Input	Notes	Example
Connection	The Rippling connection to use.
Expand	Comma-separated fields to expand: default_business_partner.	default_business_partner
Business Partner Group ID	The unique identifier for the business partner group.	bpg_abc123xyz

{
  "data": {
    "id": "bpg_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2024-01-10T09:00:00Z",
    "updated_at": "2024-01-10T09:00:00Z",
    "name": "HR Business Partners",
    "domain": "HR",
    "default_business_partner_id": "bp_01H5K8N2X3Y4Z5A6B7C8D9E0F1"
  }
}

Get Companies (V1)

GET Current Company. | key: getCompanies

Input	Notes	Example
Connection	The Rippling connection to use.

{
  "data": {
    "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
    "name": "Acme Corporation",
    "ein": "12-3456789",
    "address": {
      "street": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94105",
      "country": "US"
    },
    "phone": "+1-555-123-4567"
  }
}

Get Company Activity (V1)

GET Company Activity. | key: getCompanyActivity

Input	Notes	Example
Connection	The Rippling connection to use.
End Date	ISO 8601 timestamp to list activity before (inclusive).	2024-12-31T23:59:59Z
Limit	Maximum number of results per page. Maximum: 1000. Default: 1000.	100
Next	Pagination cursor token for retrieving the next page of results.	eyJpZCI6MTIzNDU2fQ==
Start Date	ISO 8601 timestamp to list activity after (inclusive).	2024-01-01T00:00:00Z

{
  "data": {
    "data": {
      "events": [
        {
          "id": "5ed7052182a6a429a4af3fb9",
          "request_data": null,
          "linked_events": [],
          "subjects": [
            {
              "instance": "5c6324b602bf9a760b7a4329",
              "type": "GROUP",
              "display_name": "Everyone",
              "icon": null
            },
            {
              "instance": "5c6324b502bf9a760b7a4318",
              "type": "SPOKE_USER",
              "display_name": "apps+test@rippling.com",
              "icon": null
            }
          ],
          "event_type": "EXTERNAL_GROUP_MEMBER_REMOVE",
          "timestamp": "2024-01-15T10:30:00Z",
          "company": "595f75ffd2a5f80ae22ce88e",
          "spoke": "5c63187a3698be3692ce328f",
          "owner": "5c63232bc5929135ddadbfab",
          "initiator": {
            "type": "EXTERNAL",
            "role": null,
            "display_name": "External",
            "icon": null
          },
          "event_reason": {
            "reason": "CHANGE_SYNCED_FROM_EXTERNAL_APP",
            "message": "Activity emanated from External App"
          },
          "name": "Account removed from group"
        }
      ],
      "next": "5f4d9d82f6c26e0a83aa6ea8"
    },
    "error": null
  }
}

Get Custom Fields (V1)

GET Custom Fields. | key: getCustomFields

Input	Notes	Example
Connection	The Rippling connection to use.
Limit	Sets a limit on the number of returned values.	100
Offset	Number of results to skip before returning values.	0

{
  "data": [
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
      "name": "Employee Badge Number",
      "type": "TEXT",
      "required": false
    },
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8f",
      "name": "Certification Date",
      "type": "DATE",
      "required": false
    }
  ]
}

Get Custom Object (V2)

Retrieve a specific custom object by API name. | key: getCustomObject

Input	Notes	Example
Connection	The Rippling connection to use.
Custom Object API Name	The API name of the custom object.	CustomProject__c

{
  "data": {
    "id": "co_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2023-08-01T00:00:00Z",
    "updated_at": "2024-01-10T00:00:00Z",
    "name": "Equipment Assignment",
    "description": "Track equipment assigned to employees",
    "api_name": "equipment_assignment",
    "category": "IT",
    "plural_label": "Equipment Assignments"
  }
}

Get Department (V2)

Retrieve a specific department by ID. | key: getDepartment

Input	Notes	Example
Connection	The Rippling connection to use.
Expand	Comma-separated fields to expand: parent, department_hierarchy.	parent,department_hierarchy
Department ID	The unique identifier for the department.	dept_abc123xyz

{
  "data": {
    "id": "dept_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2024-01-10T08:00:00Z",
    "name": "Engineering",
    "parent_id": null,
    "reference_code": "ENG-001",
    "department_hierarchy_id": [
      "dept_01H5K8N2X3Y4Z5A6B7C8D9E0F1"
    ]
  }
}

Get Departments (V1)

GET Departments. | key: getDepartments

Input	Notes	Example
Connection	The Rippling connection to use.
Limit	Sets a limit on the number of returned values.	100
Offset	Number of results to skip before returning values.	0

{
  "data": [
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
      "name": "Engineering",
      "parent": null
    },
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8f",
      "name": "Backend Engineering",
      "parent": "5f8a7b6c5d4e3f2a1b0c9d8e"
    }
  ]
}

Get Employees (V1)

GET Employees. | key: getEmployees

Input	Notes	Example
Connection	The Rippling connection to use.
Limit	Sets a limit on the number of returned values.	100
Offset	Number of results to skip before returning values.	0

{
  "data": [
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
      "firstName": "John",
      "lastName": "Smith",
      "email": "john.smith@acmecorp.com",
      "personalEmail": "john.smith@gmail.com",
      "phoneNumber": "+1-555-987-6543",
      "employmentType": "FULL_TIME",
      "department": "Engineering",
      "title": "Senior Software Engineer",
      "startDate": "2023-03-15",
      "endDate": null,
      "status": "ACTIVE",
      "manager": "5f8a7b6c5d4e3f2a1b0c9d8f",
      "workLocation": "San Francisco HQ"
    }
  ]
}

Get Employees Employee Id (V1)

GET Employee. | key: getEmployeesEmployeeId

Input	Notes	Example
Connection	The Rippling connection to use.
Employee ID	The unique identifier for the employee in Rippling.	123456

{
  "data": {
    "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@acmecorp.com",
    "personalEmail": "john.smith@gmail.com",
    "phoneNumber": "+1-555-987-6543",
    "employmentType": "FULL_TIME",
    "department": "Engineering",
    "title": "Senior Software Engineer",
    "startDate": "2023-03-15",
    "endDate": null,
    "status": "ACTIVE",
    "manager": "5f8a7b6c5d4e3f2a1b0c9d8f",
    "workLocation": "San Francisco HQ",
    "ssn": "***-**-1234",
    "dateOfBirth": "1985-07-22",
    "address": {
      "street": "456 Oak Avenue",
      "city": "San Jose",
      "state": "CA",
      "zip": "95112",
      "country": "US"
    }
  }
}

Get Employees Include Terminated (V1)

GET Employees (Including Terminated). | key: getEmployeesIncludeTerminated

Input	Notes	Example
Connection	The Rippling connection to use.
EIN	Employer Identification Number (EIN), also known as the Federal Employer Identification Number or Federal Tax Identification Number.	123456789
Limit	Sets a limit on the number of returned values.	100
Offset	Number of results to skip before returning values.	0

{
  "data": [
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
      "firstName": "John",
      "lastName": "Smith",
      "email": "john.smith@acmecorp.com",
      "status": "ACTIVE"
    },
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8f",
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane.doe@acmecorp.com",
      "status": "TERMINATED",
      "endDate": "2023-12-31"
    }
  ]
}

Get Employment Type (V2)

Retrieve a specific employment type by ID. | key: getEmploymentType

Input	Notes	Example
Connection	The Rippling connection to use.
Employment Type ID	The unique identifier for the employment type.	emp_type_abc123xyz

{
  "data": {
    "id": "et_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z",
    "label": "Full-Time Employee",
    "name": "FULL_TIME",
    "type": "EMPLOYEE",
    "compensation_time_period": "SALARIED",
    "amount_worked": "FULL-TIME"
  }
}

Get Groups (V1)

GET Groups. | key: getGroups

Input	Notes	Example
Connection	The Rippling connection to use.

{
  "data": [
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
      "name": "Engineering Group",
      "spokeId": "spoke_123",
      "users": [
        "usr_001",
        "usr_002",
        "usr_003"
      ],
      "version": 1
    }
  ]
}

Get Job Function (V2)

Retrieve a specific job function by ID. | key: getJobFunction

Input	Notes	Example
Connection	The Rippling connection to use.
Job Function ID	The unique identifier for the job function.	job_func_abc123xyz

{
  "data": {
    "id": "jf_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z",
    "name": "Software Engineering"
  }
}

Get Leave Requests (V1)

GET Leave Requests. | key: getLeaveRequests

Input	Notes	Example
Connection	The Rippling connection to use.
End Date	The end date of the leave in YYYY-MM-DD format.	2024-01-19
From	Filter start date to capture leave requests that overlap with this date range.	2024-01-01
ID	The unique identifier of the leave request.	lr_123456
Leave Policy	The leave policy identifier or name.	PTO
Processed By	The identifier or email of the person who processed the leave request.	manager@example.com
Requested By	The identifier or email of the person who requested the leave.	john.doe@example.com
Role	The role associated with the leave request.	Manager
Start Date	The start date of the leave in YYYY-MM-DD format.	2024-01-15
Status	The status of the leave request.	APPROVED
To	Filter end date to capture leave requests that overlap with this date range.	2024-12-31

{
  "data": [
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
      "requestedBy": "5f8a7b6c5d4e3f2a1b0c9d8f",
      "status": "PENDING",
      "startDate": "2024-02-01",
      "endDate": "2024-02-05",
      "leavePolicy": "PTO",
      "reason": "Family vacation",
      "processedBy": null
    }
  ]
}

Get Levels (V1)

GET Levels. | key: getLevels

Input	Notes	Example
Connection	The Rippling connection to use.
Limit	Sets a limit on the number of returned values.	100
Offset	Number of results to skip before returning values.	0

{
  "data": [
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
      "name": "L1 - Entry Level",
      "rank": 1
    },
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8f",
      "name": "L2 - Junior",
      "rank": 2
    },
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d90",
      "name": "L3 - Mid-Level",
      "rank": 3
    },
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d91",
      "name": "L4 - Senior",
      "rank": 4
    }
  ]
}

Get Me (V1)

GET Current User. | key: getMe

Input	Notes	Example
Connection	The Rippling connection to use.

{
  "data": {
    "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
    "email": "john.smith@acmecorp.com",
    "firstName": "John",
    "lastName": "Smith",
    "role": "ADMIN",
    "companyId": "5f8a7b6c5d4e3f2a1b0c9d8f"
  }
}

Get Object Category (V2)

Retrieve a specific object category by ID. | key: getObjectCategory

Input	Notes	Example
Connection	The Rippling connection to use.
Object Category ID	The unique identifier for the object category.	cat_abc123xyz

{
  "data": {
    "id": "oc_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "name": "HR",
    "description": "Human Resources related objects"
  }
}

Get Saml Idp Metadata (V1)

GET SAML Metadata. | key: getSamlIdpMetadata

Input	Notes	Example
Connection	The Rippling connection to use.

{
  "data": {
    "entityId": "https://app.rippling.com/saml/metadata",
    "ssoUrl": "https://app.rippling.com/saml/sso",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIC...\n-----END CERTIFICATE-----"
  }
}

Get SSO Me (V2)

Retrieve SSO information of the current user. | key: getSsoMe

Input	Notes	Example
Connection	The Rippling connection to use.
Expand	Comma-separated fields to expand: company.	company

{
  "data": {
    "id": "usr_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "email": "john.smith@acmecorp.com",
    "name": "John Smith",
    "company_id": "cmp_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "worker_id": "wkr_01H5K8N2X3Y4Z5A6B7C8D9E0F1"
  }
}

Get Supergroup (V2)

Retrieve a specific supergroup by ID. | key: getSupergroup

Input	Notes	Example
Connection	The Rippling connection to use.
Supergroup ID	The unique identifier for the supergroup.	sgrp_abc123xyz

{
  "data": {
    "id": "sg_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2023-04-01T00:00:00Z",
    "updated_at": "2024-01-10T00:00:00Z",
    "name": "All Employees",
    "type": "DYNAMIC"
  }
}

Get Team (V2)

Retrieve a specific team by ID. | key: getTeam

Input	Notes	Example
Connection	The Rippling connection to use.
Expand	Comma-separated fields to expand: parent.	parent
Team ID	The unique identifier for the team.	team_abc123xyz

{
  "data": {
    "id": "team_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2023-02-15T09:00:00Z",
    "updated_at": "2024-01-12T11:00:00Z",
    "name": "Platform Team",
    "parent_id": null
  }
}

Get Teams (V1)

GET Teams. | key: getTeams

Input	Notes	Example
Connection	The Rippling connection to use.
Limit	Sets a limit on the number of returned values.	100
Offset	Number of results to skip before returning values.	0

{
  "data": [
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
      "name": "Platform Team",
      "parent": null
    },
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8f",
      "name": "API Team",
      "parent": "5f8a7b6c5d4e3f2a1b0c9d8e"
    }
  ]
}

Get User (V2)

Retrieve a specific user by ID. | key: getUser

Input	Notes	Example
Connection	The Rippling connection to use.
User ID	The unique identifier for the user.	usr_abc123xyz

{
  "data": {
    "id": "usr_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2023-03-15T10:00:00Z",
    "updated_at": "2024-01-15T14:30:00Z",
    "active": true,
    "username": "john.smith@acmecorp.com",
    "display_name": "John Smith",
    "name": {
      "formatted": "John Smith",
      "family_name": "Smith",
      "given_name": "John"
    },
    "emails": [
      {
        "value": "john.smith@acmecorp.com",
        "type": "WORK"
      }
    ],
    "preferred_language": "en-US",
    "timezone": "America/Los_Angeles"
  }
}

Get Work Location (V2)

Retrieve a specific work location by ID. | key: getWorkLocation

Input	Notes	Example
Connection	The Rippling connection to use.
Work Location ID	The unique identifier for the work location.	loc_abc123xyz

{
  "data": {
    "id": "wl_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2024-01-05T10:00:00Z",
    "name": "San Francisco HQ",
    "address": {
      "type": "WORK",
      "formatted": "123 Main Street, San Francisco, CA 94105, US",
      "street_address": "123 Main Street",
      "locality": "San Francisco",
      "region": "CA",
      "postal_code": "94105",
      "country": "US"
    }
  }
}

Get Work Locations (V1)

GET Work Locations. | key: getWorkLocations

Input	Notes	Example
Connection	The Rippling connection to use.
Limit	Sets a limit on the number of returned values.	100
Offset	Number of results to skip before returning values.	0

{
  "data": [
    {
      "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
      "name": "San Francisco HQ",
      "address": {
        "street": "123 Main Street",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94105",
        "country": "US"
      }
    }
  ]
}

Get Worker (V2)

Retrieve a specific worker by ID. | key: getWorker

Input	Notes	Example
Connection	The Rippling connection to use.
Expand	Comma-separated fields to expand: user, manager, legal_entity, employment_type, compensation, department, teams, level, custom_fields, business_partners.	user,manager,department
Worker ID	The unique identifier for the worker.	wkr_abc123xyz

{
  "data": {
    "id": "wkr_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2023-03-15T10:00:00Z",
    "updated_at": "2024-01-15T14:30:00Z",
    "user_id": "usr_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "is_manager": true,
    "manager_id": "wkr_02H5K8N2X3Y4Z5A6B7C8D9E0F2",
    "legal_entity_id": "le_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "country": "US",
    "start_date": "2023-03-15",
    "end_date": null,
    "number": 1001,
    "work_email": "john.smith@acmecorp.com",
    "personal_email": "john.smith@gmail.com",
    "status": "ACTIVE",
    "employment_type_id": "et_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "gender": "MALE",
    "date_of_birth": "1985-07-22",
    "location": {
      "type": "OFFICE",
      "work_location_id": "wl_01H5K8N2X3Y4Z5A6B7C8D9E0F1"
    }
  }
}

List Business Partner Groups (V2)

Retrieve a list of business partner groups. | key: listBusinessPartnerGroups

Input	Notes	Example
Connection	The Rippling connection to use.
Cursor	Pagination cursor token from the next_link field in the previous API response.	eyJpZCI6MTIzNDU2fQ==
Expand	Comma-separated fields to expand: default_business_partner.	default_business_partner
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "bpg_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2024-01-10T09:00:00Z",
        "updated_at": "2024-01-10T09:00:00Z",
        "name": "HR Business Partners",
        "domain": "HR",
        "default_business_partner_id": "bp_01H5K8N2X3Y4Z5A6B7C8D9E0F1"
      }
    ],
    "next_link": null
  }
}

List Business Partners (V2)

Retrieve a list of business partners. | key: listBusinessPartners

Input	Notes	Example
Connection	The Rippling connection to use.
Cursor	Pagination cursor token from the next_link field in the previous API response.	eyJpZCI6MTIzNDU2fQ==
Expand	Comma-separated fields to expand: business_partner_group, worker, client_group.	business_partner_group,worker,client_group
Filter	Filterable fields: worker_id, business_partner_group_id. Example: worker_id eq 'abc123'.	worker_id eq 'abc123'
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "bp_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z",
        "business_partner_group_id": "bpg_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "worker_id": "wkr_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "client_group_id": "grp_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "client_group_member_count": 25
      }
    ],
    "next_link": "https://rest.ripplingapis.com/business-partners?cursor=abc123"
  }
}

List Companies (V2)

Retrieve a list of companies. | key: listCompanies

Input	Notes	Example
Connection	The Rippling connection to use.
Cursor	Pagination cursor token from the next_link field in the previous API response.	eyJpZCI6MTIzNDU2fQ==
Expand	Comma-separated fields to expand: parent_legal_entity, legal_entities.	parent_legal_entity,legal_entities
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "cmp_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2023-06-01T08:00:00Z",
        "updated_at": "2024-01-15T12:00:00Z",
        "name": "Acme Corporation",
        "legal_name": "Acme Corporation Inc.",
        "doing_business_as_name": "Acme Corp",
        "phone": "+1-555-123-4567",
        "primary_email": "contact@acmecorp.com",
        "parent_legal_entity_id": "le_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "legal_entities_id": [
          "le_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
          "le_02H5K8N2X3Y4Z5A6B7C8D9E0F2"
        ],
        "physical_address": {
          "type": "WORK",
          "formatted": "123 Main Street, San Francisco, CA 94105, US",
          "street_address": "123 Main Street",
          "locality": "San Francisco",
          "region": "CA",
          "postal_code": "94105",
          "country": "US"
        }
      }
    ],
    "next_link": null
  }
}

List Custom Fields (V2)

Retrieve a list of custom fields. | key: listCustomFields

Input	Notes	Example
Connection	The Rippling connection to use.
Cursor	Pagination cursor token from the next_link field in the previous API response.	eyJpZCI6MTIzNDU2fQ==
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "cf_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2023-05-01T00:00:00Z",
        "updated_at": "2023-05-01T00:00:00Z",
        "name": "Employee Badge Number",
        "description": "Unique badge number for building access",
        "required": false,
        "type": "TEXT"
      },
      {
        "id": "cf_02H5K8N2X3Y4Z5A6B7C8D9E0F2",
        "created_at": "2023-05-01T00:00:00Z",
        "updated_at": "2023-05-01T00:00:00Z",
        "name": "Certification Date",
        "description": "Date of professional certification",
        "required": false,
        "type": "DATE"
      }
    ],
    "next_link": null
  }
}

List Custom Objects (V2)

Retrieve a list of custom objects. | key: listCustomObjects

Input	Notes	Example
Connection	The Rippling connection to use.

{
  "data": {
    "results": [
      {
        "id": "co_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2023-08-01T00:00:00Z",
        "updated_at": "2024-01-10T00:00:00Z",
        "name": "Equipment Assignment",
        "description": "Track equipment assigned to employees",
        "api_name": "equipment_assignment",
        "category": "IT",
        "plural_label": "Equipment Assignments"
      }
    ],
    "next_link": null
  }
}

List Departments (V2)

Retrieve a list of departments. | key: listDepartments

Input	Notes	Example
Connection	The Rippling connection to use.
Cursor	Pagination cursor token from the next_link field in the previous API response.	eyJpZCI6MTIzNDU2fQ==
Expand	Comma-separated fields to expand: parent, department_hierarchy.	parent,department_hierarchy
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "dept_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2023-01-01T00:00:00Z",
        "updated_at": "2024-01-10T08:00:00Z",
        "name": "Engineering",
        "parent_id": null,
        "reference_code": "ENG-001",
        "department_hierarchy_id": [
          "dept_01H5K8N2X3Y4Z5A6B7C8D9E0F1"
        ]
      },
      {
        "id": "dept_02H5K8N2X3Y4Z5A6B7C8D9E0F2",
        "created_at": "2023-01-01T00:00:00Z",
        "updated_at": "2024-01-10T08:00:00Z",
        "name": "Backend Engineering",
        "parent_id": "dept_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "reference_code": "ENG-002",
        "department_hierarchy_id": [
          "dept_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
          "dept_02H5K8N2X3Y4Z5A6B7C8D9E0F2"
        ]
      }
    ],
    "next_link": null
  }
}

List Employment Types (V2)

Retrieve a list of employment types. | key: listEmploymentTypes

Input	Notes	Example
Connection	The Rippling connection to use.
Cursor	Pagination cursor token from the next_link field in the previous API response.	eyJpZCI6MTIzNDU2fQ==
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "et_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2023-01-01T00:00:00Z",
        "updated_at": "2023-01-01T00:00:00Z",
        "label": "Full-Time Employee",
        "name": "FULL_TIME",
        "type": "EMPLOYEE",
        "compensation_time_period": "SALARIED",
        "amount_worked": "FULL-TIME"
      },
      {
        "id": "et_02H5K8N2X3Y4Z5A6B7C8D9E0F2",
        "created_at": "2023-01-01T00:00:00Z",
        "updated_at": "2023-01-01T00:00:00Z",
        "label": "Part-Time Employee",
        "name": "PART_TIME",
        "type": "EMPLOYEE",
        "compensation_time_period": "HOURLY",
        "amount_worked": "PART-TIME"
      },
      {
        "id": "et_03H5K8N2X3Y4Z5A6B7C8D9E0F3",
        "created_at": "2023-01-01T00:00:00Z",
        "updated_at": "2023-01-01T00:00:00Z",
        "label": "Contractor",
        "name": "CONTRACTOR",
        "type": "CONTRACTOR",
        "compensation_time_period": "HOURLY",
        "amount_worked": "FULL-TIME"
      }
    ],
    "next_link": null
  }
}

List Entitlements (V2)

Retrieve a list of entitlements. | key: listEntitlements

Input	Notes	Example
Connection	The Rippling connection to use.

{
  "data": {
    "results": [
      {
        "id": "ent_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "name": "API_Tier_1",
        "description": "Access to Tier 1 API endpoints"
      },
      {
        "id": "ent_02H5K8N2X3Y4Z5A6B7C8D9E0F2",
        "name": "Time_And_Attendance_API",
        "description": "Access to Time and Attendance API endpoints"
      }
    ],
    "next_link": null
  }
}

List Job Functions (V2)

Retrieve a list of job functions. | key: listJobFunctions

Input	Notes	Example
Connection	The Rippling connection to use.
Cursor	Pagination cursor token from the next_link field in the previous API response.	eyJpZCI6MTIzNDU2fQ==
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "jf_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2023-01-01T00:00:00Z",
        "updated_at": "2023-01-01T00:00:00Z",
        "name": "Software Engineering"
      },
      {
        "id": "jf_02H5K8N2X3Y4Z5A6B7C8D9E0F2",
        "created_at": "2023-01-01T00:00:00Z",
        "updated_at": "2023-01-01T00:00:00Z",
        "name": "Product Management"
      }
    ],
    "next_link": null
  }
}

List Object Categories (V2)

Retrieve a list of object categories. | key: listObjectCategories

Input	Notes	Example
Connection	The Rippling connection to use.

{
  "data": {
    "results": [
      {
        "id": "oc_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "name": "HR",
        "description": "Human Resources related objects"
      },
      {
        "id": "oc_02H5K8N2X3Y4Z5A6B7C8D9E0F2",
        "name": "IT",
        "description": "Information Technology related objects"
      }
    ],
    "next_link": null
  }
}

List Supergroups (V2)

Retrieve supergroups matching the input parameters. | key: listSupergroups

Input	Notes	Example
Connection	The Rippling connection to use.
Filter	Filterable fields: app_owner_id, group_type. Example: app_owner_id eq 'abc123'.	app_owner_id eq 'abc123'
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "sg_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2023-04-01T00:00:00Z",
        "updated_at": "2024-01-10T00:00:00Z",
        "name": "All Employees",
        "type": "DYNAMIC"
      }
    ],
    "next_link": null
  }
}

List Teams (V2)

Retrieve a list of teams. | key: listTeams

Input	Notes	Example
Connection	The Rippling connection to use.
Cursor	Pagination cursor token from the next_link field in the previous API response.	eyJpZCI6MTIzNDU2fQ==
Expand	Comma-separated fields to expand: parent.	parent
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "team_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2023-02-15T09:00:00Z",
        "updated_at": "2024-01-12T11:00:00Z",
        "name": "Platform Team",
        "parent_id": null
      },
      {
        "id": "team_02H5K8N2X3Y4Z5A6B7C8D9E0F2",
        "created_at": "2023-02-15T09:00:00Z",
        "updated_at": "2024-01-12T11:00:00Z",
        "name": "API Team",
        "parent_id": "team_01H5K8N2X3Y4Z5A6B7C8D9E0F1"
      }
    ],
    "next_link": null
  }
}

List Users (V2)

Retrieve a list of users. | key: listUsers

Input	Notes	Example
Connection	The Rippling connection to use.
Cursor	Pagination cursor token from the next_link field in the previous API response.	eyJpZCI6MTIzNDU2fQ==
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "usr_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2023-03-15T10:00:00Z",
        "updated_at": "2024-01-15T14:30:00Z",
        "active": true,
        "username": "john.smith@acmecorp.com",
        "display_name": "John Smith",
        "name": {
          "formatted": "John Smith",
          "family_name": "Smith",
          "given_name": "John",
          "middle_name": null,
          "honorific_prefix": null,
          "honorific_suffix": null
        },
        "emails": [
          {
            "value": "john.smith@acmecorp.com",
            "type": "WORK",
            "display": "john.smith@acmecorp.com"
          }
        ],
        "phone_numbers": [
          {
            "value": "+1-555-987-6543",
            "type": "WORK"
          }
        ],
        "addresses": [
          {
            "type": "HOME",
            "formatted": "456 Oak Avenue, San Jose, CA 95112, US",
            "street_address": "456 Oak Avenue",
            "locality": "San Jose",
            "region": "CA",
            "postal_code": "95112",
            "country": "US"
          }
        ],
        "preferred_language": "en-US",
        "locale": "en-US",
        "timezone": "America/Los_Angeles",
        "number": "1001"
      }
    ],
    "next_link": null
  }
}

List Work Locations (V2)

Retrieve a list of work locations. | key: listWorkLocations

Input	Notes	Example
Connection	The Rippling connection to use.
Cursor	Pagination cursor token from the next_link field in the previous API response.	eyJpZCI6MTIzNDU2fQ==
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "wl_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2023-01-01T00:00:00Z",
        "updated_at": "2024-01-05T10:00:00Z",
        "name": "San Francisco HQ",
        "address": {
          "type": "WORK",
          "formatted": "123 Main Street, San Francisco, CA 94105, US",
          "street_address": "123 Main Street",
          "locality": "San Francisco",
          "region": "CA",
          "postal_code": "94105",
          "country": "US"
        }
      }
    ],
    "next_link": null
  }
}

List Workers (V2)

Retrieve a list of workers with filtering, expansion, and sorting support. | key: listWorkers

Input	Notes	Example
Connection	The Rippling connection to use.
Cursor	Pagination cursor token from the next_link field in the previous API response.	eyJpZCI6MTIzNDU2fQ==
Expand	Comma-separated fields to expand: user, manager, legal_entity, employment_type, compensation, department, teams, level, custom_fields, business_partners.	user,manager,department
Filter	Filter expression. Filterable fields: status, work_email, user_id, created_at, updated_at. Example: status eq 'ACTIVE'.	status eq 'ACTIVE'
Order By	Sortable fields: id, created_at, updated_at. Example: created_at desc.	created_at desc

{
  "data": {
    "results": [
      {
        "id": "wkr_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "created_at": "2023-03-15T10:00:00Z",
        "updated_at": "2024-01-15T14:30:00Z",
        "user_id": "usr_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "is_manager": true,
        "manager_id": "wkr_02H5K8N2X3Y4Z5A6B7C8D9E0F2",
        "legal_entity_id": "le_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "country": "US",
        "start_date": "2023-03-15",
        "end_date": null,
        "number": 1001,
        "work_email": "john.smith@acmecorp.com",
        "personal_email": "john.smith@gmail.com",
        "status": "ACTIVE",
        "employment_type_id": "et_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
        "gender": "MALE",
        "date_of_birth": "1985-07-22",
        "location": {
          "type": "OFFICE",
          "work_location_id": "wl_01H5K8N2X3Y4Z5A6B7C8D9E0F1"
        }
      }
    ],
    "next_link": "https://rest.ripplingapis.com/workers?cursor=xyz789"
  }
}

Patch Groups Group Id (V1)

PATCH Group. | key: patchGroupsGroupId

Input	Notes	Example
Connection	The Rippling connection to use.
Group ID	The unique identifier for the group in Rippling.	12345
Name	The name of the Group.	Engineering Team
Spoke ID	The external identifier of the Group.	ext_group_123
Users	The array of users within the Group.	[123456, 789012]
Version	The version identifier of the group.	v1

{
  "data": {
    "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
    "name": "Patched Engineering Group",
    "spokeId": "spoke_123",
    "users": [
      "usr_001",
      "usr_002"
    ],
    "version": 3
  }
}

Post Ats Candidates Push Candidate (V1)

POST New Candidate. | key: postAtsCandidatesPushCandidate

Input	Notes	Example
Attachments	URLs or identifiers for attachments related to the candidate.	https://example.com/resume.pdf
Candidate ID	The unique identifier of the candidate from your ATS (Applicant Tracking System).	cand_123456
Connection	The Rippling connection to use.
Currency	The currency code in ISO 4217 format (e.g., USD, EUR, GBP).	USD
Department	The name of the department the candidate will join.	Engineering
Email	The candidate's email address.	john.doe@example.com
Employment Type	The type of employment for the candidate.
Equity Shares	The number of equity shares to be granted to the candidate.	5000
Job Title	The job title for the candidate's position.	Senior Software Engineer
Name	The candidate's full name.	Jane Smith
Phone Number	The candidate's phone number.	+1-555-123-4567
Salary Per Unit	The monetary amount the candidate will be paid per salary unit.	75000.00
Salary Unit	The frequency at which the candidate will be paid.
Signing Bonus	The one-time signing bonus amount given to the candidate.	10000.00
Start Date	The expected start date for the candidate in YYYY-MM-DD format.	2024-03-01

{
  "data": {
    "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
    "candidateId": "candidate_ext_001",
    "name": "Sarah Johnson",
    "email": "sarah.johnson@example.com",
    "phoneNumber": "+1-555-234-5678",
    "jobTitle": "Software Engineer",
    "startDate": "2024-03-01",
    "department": "Engineering",
    "salaryUnit": "YEAR",
    "salaryPerUnit": 120000,
    "currency": "USD",
    "employmentType": "FULL_TIME",
    "status": "CREATED"
  }
}

Post Groups (V1)

POST Groups. | key: postGroups

Input	Notes	Example
Connection	The Rippling connection to use.
Name	The name of the group.	Engineering Team
Spoke ID	The external unique identifier for the group entity in your application.	ext_group_123
Users	An array of Rippling user IDs to include in the group.	[123456, 789012]

{
  "data": {
    "id": "5f8a7b6c5d4e3f2a1b0c9d8f",
    "name": "New Engineering Group",
    "spokeId": "spoke_456",
    "users": [
      "usr_001"
    ],
    "version": 1
  }
}

Post Mark App Installed (V1)

Mark App Installed. | key: postMarkAppInstalled

Input	Notes	Example
Connection	The Rippling connection to use.

{
  "data": {
    "ok": true
  }
}

Process Leave Requests (V1)

POST Process Leave Request. | key: processLeaveRequests

Input	Notes	Example
Action	The action to take on the leave request.
Connection	The Rippling connection to use.
ID	The unique identifier of the leave request to be processed.	lr_123456

{
  "data": {
    "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
    "requestedBy": "5f8a7b6c5d4e3f2a1b0c9d8f",
    "status": "APPROVED",
    "startDate": "2024-02-01",
    "endDate": "2024-02-05",
    "leavePolicy": "PTO",
    "reason": "Family vacation",
    "processedBy": "5f8a7b6c5d4e3f2a1b0c9d90"
  }
}

Put Groups Group Id (V1)

PUT Group. | key: putGroupsGroupId

Input	Notes	Example
Connection	The Rippling connection to use.
Group ID	The unique identifier for the group in Rippling.	12345
Name	The name of the Group.	Engineering Team
Spoke ID	The external identifier of the Group.	ext_group_123
Users	The array of users within the Group.	[123456, 789012]
Version	The version identifier of the group.	v1

{
  "data": {
    "id": "5f8a7b6c5d4e3f2a1b0c9d8e",
    "name": "Updated Engineering Group",
    "spokeId": "spoke_123",
    "users": [
      "usr_001",
      "usr_002",
      "usr_003",
      "usr_004"
    ],
    "version": 2
  }
}

Raw Request (V1)

Send raw HTTP request to Rippling API. | key: rawRequest

Input	Notes	Example
Connection	The Rippling connection to use.
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/companies/current), The base URL is already included (https://api.rippling.com/platform/api). For example, to connect to https://api.rippling.com/platform/api/companies/current, only /companies/current is entered in this field.	/companies/current
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

{
  "data": {
    "message": "Raw request completed successfully"
  }
}

Raw Request (V2)

Send raw HTTP request to Rippling API. | key: rawRequestV2

Input	Notes	Example
Connection	The Rippling connection to use.
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/workers), The base URL is already included (https://rest.ripplingapis.com). For example, to connect to https://rest.ripplingapis.com/workers, only /workers is entered in this field.	/workers
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

{
  "data": {
    "message": "Raw request to V2 API completed successfully"
  }
}

Update Custom Object (V2)

Update an existing custom object. | key: updateCustomObject

Input	Notes	Example
Category	The new category for the custom object.	Operations
Connection	The Rippling connection to use.
Custom Object API Name	The API name of the custom object to update.	CustomProject__c
Description	The new description for the custom object.	Department responsible for product development and technical infrastructure
Name	The new name for the custom object.	Engineering Department
Owner Role	The owner role for the custom object.	Admin
Plural Label	The plural label for the custom object.	Custom Projects

{
  "data": {
    "id": "co_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "created_at": "2023-08-01T00:00:00Z",
    "updated_at": "2024-01-15T12:00:00Z",
    "name": "Equipment Assignment Updated",
    "description": "Track equipment assigned to employees - updated",
    "api_name": "equipment_assignment",
    "category": "IT",
    "plural_label": "Equipment Assignments"
  }
}

Update Object Category (V2)

Update an existing object category. | key: updateObjectCategory

Input	Notes	Example
Connection	The Rippling connection to use.
Description	The new description for the object category.	Department responsible for product development and technical infrastructure
Object Category ID	Unique identifier for the object category to update.	cat_abc123xyz
Name	The new name for the object category.	Engineering Department

{
  "data": {
    "id": "oc_01H5K8N2X3Y4Z5A6B7C8D9E0F1",
    "name": "Human Resources",
    "description": "Human Resources related objects - updated"
  }
}

Changelog

2026-03-05

Added inline data sources for workers, departments, teams, users, work locations, employment types, job functions, supergroups, business partner groups, and object categories to enable dynamic dropdown selection

2026-02-25

Added comprehensive V2 API actions with improved filtering, expansion, and sorting support:

Business Partner Groups - List, Get, Create, and Delete business partner groups
Business Partners - List, Get, Create, and Delete business partners
Companies - List companies
Custom Fields - List custom fields
Custom Objects - List, Get, Create, Update, and Delete custom objects
Departments - List and Get departments
Employment Types - List and Get employment types
Entitlements - List entitlements
Job Functions - List and Get job functions
Object Categories - List, Get, Create, Update, and Delete object categories
Supergroups - List and Get supergroups
Teams - List and Get teams
Users - List and Get users
Work Locations - List and Get work locations
Workers - List and Get workers
Get SSO Me - Retrieve current user information
Raw Request (V2) - Make custom V2 API requests

Rippling makes it easy to manage your company's Payroll, Benefits, HR, and IT—all in one, modern platform.

Description​

Connections​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

Bearer API Key​

Prerequisites​

Setup Steps​

Configure the Connection​

Verify Connection​

Data Sources​

Select Business Partner Group​

Select Department​

Select Employment Type​

Select Job Function​

Select Object Category​

Select Supergroup​

Select Team​

Select User​

Select Work Location​

Select Worker​

Actions​

Create Business Partner (V2)​

Create Business Partner Group (V2)​

Create Custom Object (V2)​

Create Object Category (V2)​

Delete Business Partner (V2)​

Delete Business Partner Group (V2)​

Delete Custom Object (V2)​

Delete Groups Group Id (V1)​

Delete Object Category (V2)​

Get Business Partner (V2)​

Get Business Partner Group (V2)​

Get Companies (V1)​

Get Company Activity (V1)​

Get Custom Fields (V1)​

Get Custom Object (V2)​

Get Department (V2)​

Get Departments (V1)​

Get Employees (V1)​

Get Employees Employee Id (V1)​

Get Employees Include Terminated (V1)​

Get Employment Type (V2)​

Get Groups (V1)​

Get Job Function (V2)​

Get Leave Requests (V1)​

Get Levels (V1)​

Get Me (V1)​

Get Object Category (V2)​

Get Saml Idp Metadata (V1)​

Get SSO Me (V2)​

Get Supergroup (V2)​

Get Team (V2)​

Get Teams (V1)​

Get User (V2)​

Get Work Location (V2)​

Get Work Locations (V1)​

Get Worker (V2)​

List Business Partner Groups (V2)​

List Business Partners (V2)​

List Companies (V2)​

List Custom Fields (V2)​

List Custom Objects (V2)​

List Departments (V2)​

List Employment Types (V2)​

List Entitlements (V2)​

List Job Functions (V2)​

List Object Categories (V2)​

List Supergroups (V2)​

List Teams (V2)​

List Users (V2)​

List Work Locations (V2)​

List Workers (V2)​

Patch Groups Group Id (V1)​

Post Ats Candidates Push Candidate (V1)​

Post Groups (V1)​

Post Mark App Installed (V1)​

Process Leave Requests (V1)​

Description

Connections

OAuth 2.0

Prerequisites

Setup Steps

Configure the Connection

Bearer API Key

Prerequisites

Setup Steps

Configure the Connection

Verify Connection

Data Sources

Select Business Partner Group

Select Department

Select Employment Type

Select Job Function

Select Object Category

Select Supergroup

Select Team

Select User

Select Work Location

Select Worker

Actions

Create Business Partner (V2)

Create Business Partner Group (V2)

Create Custom Object (V2)

Create Object Category (V2)

Delete Business Partner (V2)

Delete Business Partner Group (V2)

Delete Custom Object (V2)

Delete Groups Group Id (V1)

Delete Object Category (V2)

Get Business Partner (V2)

Get Business Partner Group (V2)

Get Companies (V1)

Get Company Activity (V1)

Get Custom Fields (V1)

Get Custom Object (V2)

Get Department (V2)

Get Departments (V1)

Get Employees (V1)

Get Employees Employee Id (V1)

Get Employees Include Terminated (V1)

Get Employment Type (V2)

Get Groups (V1)

Get Job Function (V2)

Get Leave Requests (V1)

Get Levels (V1)

Get Me (V1)

Get Object Category (V2)

Get Saml Idp Metadata (V1)

Get SSO Me (V2)

Get Supergroup (V2)

Get Team (V2)

Get Teams (V1)

Get User (V2)

Get Work Location (V2)

Get Work Locations (V1)

Get Worker (V2)

List Business Partner Groups (V2)

List Business Partners (V2)

List Companies (V2)

List Custom Fields (V2)

List Custom Objects (V2)

List Departments (V2)

List Employment Types (V2)

List Entitlements (V2)

List Job Functions (V2)

List Object Categories (V2)

List Supergroups (V2)

List Teams (V2)

List Users (V2)

List Work Locations (V2)

List Workers (V2)

Patch Groups Group Id (V1)

Post Ats Candidates Push Candidate (V1)

Post Groups (V1)

Post Mark App Installed (V1)

Process Leave Requests (V1)

Put Groups Group Id (V1)