# Rippling (/integrations/rippling)
{/* MANUAL-CONTENT-START:intro */}
Use [Rippling](https://www.rippling.com/) to read workforce data, manage organizational resources and custom objects, and configure custom apps and pages. Connect with an API key. Reporting actions start a report run and retrieve its result; Create Draft Hires submits employees to the onboarding flow.
{/* MANUAL-CONTENT-END */}
## Use the block [#usage-instructions]
Manage workers, users, departments, teams, titles, work locations, business partners, supergroups, custom objects, custom apps, custom pages, custom settings, object categories, reports, and draft hires.
## Actions [#actions]
### Rippling List Workers [#rippling-list-workers]
List all workers with optional filtering and pagination
#### Input [#input]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `filter` | string | No | Filter expression |
| `expand` | string | No | Comma-separated fields to expand |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output]
| Parameter | Type | Description |
| - | - | - |
| `workers` | array | List of workers |
| ↳ `id` | string | Worker ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `user_id` | string | Associated user ID |
| ↳ `is_manager` | boolean | Whether the worker is a manager |
| ↳ `manager_id` | string | Manager worker ID |
| ↳ `legal_entity_id` | string | Legal entity ID |
| ↳ `country` | string | Worker country code |
| ↳ `start_date` | string | Employment start date |
| ↳ `end_date` | string | Employment end date |
| ↳ `number` | number | Worker number |
| ↳ `work_email` | string | Work email address |
| ↳ `personal_email` | string | Personal email address |
| ↳ `status` | string | Worker status (INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED) |
| ↳ `employment_type_id` | string | Employment type ID |
| ↳ `department_id` | string | Department ID |
| ↳ `teams_id` | json | Array of team IDs |
| ↳ `title` | string | Job title |
| ↳ `level_id` | string | Level ID |
| ↳ `compensation_id` | string | Compensation ID |
| ↳ `overtime_exemption` | string | Overtime exemption status (EXEMPT, NON\_EXEMPT) |
| ↳ `title_effective_date` | string | Title effective date |
| ↳ `business_partners_id` | json | Array of business partner IDs |
| ↳ `location` | json | Worker location (type, work\_location\_id) |
| ↳ `gender` | string | Gender |
| ↳ `date_of_birth` | string | Date of birth |
| ↳ `race` | string | Race |
| ↳ `ethnicity` | string | Ethnicity |
| ↳ `citizenship` | string | Citizenship country code |
| ↳ `termination_details` | json | Termination details |
| ↳ `custom_fields` | json | Custom fields (expandable) |
| ↳ `country_fields` | json | Country-specific fields |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Worker [#rippling-get-worker]
Get a specific worker by ID
#### Input [#input-1]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
| `expand` | string | No | Comma-separated fields to expand |
#### Output [#output-1]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Worker ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `user_id` | string | User ID |
| `is_manager` | boolean | Is manager |
| `manager_id` | string | Manager ID |
| `legal_entity_id` | string | Legal entity ID |
| `country` | string | Country |
| `start_date` | string | Start date |
| `end_date` | string | End date |
| `number` | number | Worker number |
| `work_email` | string | Work email |
| `personal_email` | string | Personal email |
| `status` | string | Status |
| `employment_type_id` | string | Employment type ID |
| `department_id` | string | Department ID |
| `teams_id` | json | Team IDs |
| `title` | string | Job title |
| `level_id` | string | Level ID |
| `compensation_id` | string | Compensation ID |
| `overtime_exemption` | string | Overtime exemption |
| `title_effective_date` | string | Title effective date |
| `business_partners_id` | json | Business partner IDs |
| `location` | json | Worker location |
| `gender` | string | Gender |
| `date_of_birth` | string | Date of birth |
| `race` | string | Race |
| `ethnicity` | string | Ethnicity |
| `citizenship` | string | Citizenship |
| `termination_details` | json | Termination details |
| `custom_fields` | json | Custom fields |
| `country_fields` | json | Country-specific fields |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling List Users [#rippling-list-users]
List all users with optional pagination
#### Input [#input-2]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-2]
| Parameter | Type | Description |
| - | - | - |
| `users` | array | List of users |
| ↳ `id` | string | User ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `active` | boolean | Whether the user is active |
| ↳ `username` | string | Unique username |
| ↳ `display_name` | string | Display name |
| ↳ `preferred_language` | string | Preferred language |
| ↳ `locale` | string | Locale |
| ↳ `timezone` | string | Timezone (IANA format) |
| ↳ `number` | string | Permanent profile number |
| ↳ `name` | json | User name object (given\_name, family\_name, etc.) |
| ↳ `emails` | json | Array of email objects |
| ↳ `phone_numbers` | json | Array of phone number objects |
| ↳ `addresses` | json | Array of address objects |
| ↳ `photos` | json | Array of photo objects |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get User [#rippling-get-user]
Get a specific user by ID
#### Input [#input-3]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
#### Output [#output-3]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | User ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `active` | boolean | Is active |
| `username` | string | Username |
| `display_name` | string | Display name |
| `preferred_language` | string | Preferred language |
| `locale` | string | Locale |
| `timezone` | string | Timezone |
| `number` | string | Profile number |
| `name` | json | User name object |
| `emails` | json | Email addresses |
| `phone_numbers` | json | Phone numbers |
| `addresses` | json | Addresses |
| `photos` | json | Photos |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling List Companies [#rippling-list-companies]
List all companies
#### Input [#input-4]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `expand` | string | No | Comma-separated fields to expand |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-4]
| Parameter | Type | Description |
| - | - | - |
| `companies` | array | List of companies |
| ↳ `id` | string | Company ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Company name |
| ↳ `legal_name` | string | Legal name |
| ↳ `doing_business_as_name` | string | DBA name |
| ↳ `phone` | string | Phone number |
| ↳ `primary_email` | string | Primary email |
| ↳ `parent_legal_entity_id` | string | Parent legal entity ID |
| ↳ `legal_entities_id` | json | Array of legal entity IDs |
| ↳ `physical_address` | json | Physical address of the holding entity |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Current User [#rippling-get-current-user]
Get SSO information for the current user
#### Input [#input-5]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `expand` | string | No | Comma-separated fields to expand |
#### Output [#output-5]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | User ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `work_email` | string | Work email |
| `company_id` | string | Company ID |
| `company` | json | Expanded company object |
### Rippling List Entitlements [#rippling-list-entitlements]
List all entitlements
#### Input [#input-6]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
#### Output [#output-6]
| Parameter | Type | Description |
| - | - | - |
| `entitlements` | array | List of entitlements |
| ↳ `id` | string | Entitlement ID |
| ↳ `description` | string | Entitlement description |
| ↳ `display_name` | string | Display name |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling List Departments [#rippling-list-departments]
List all departments
#### Input [#input-7]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `expand` | string | No | Comma-separated fields to expand |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-7]
| Parameter | Type | Description |
| - | - | - |
| `departments` | array | List of departments |
| ↳ `id` | string | Department ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Department name |
| ↳ `parent_id` | string | Parent department ID |
| ↳ `reference_code` | string | Reference code |
| ↳ `department_hierarchy_id` | json | Array of department IDs in hierarchy |
| ↳ `parent` | json | Expanded parent department |
| ↳ `department_hierarchy` | json | Expanded department hierarchy |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Department [#rippling-get-department]
Get a specific department by ID
#### Input [#input-8]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
| `expand` | string | No | Comma-separated fields to expand |
#### Output [#output-8]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Department ID |
| `created_at` | string | Record creation date |
| `updated_at` | string | Record update date |
| `name` | string | Department name |
| `parent_id` | string | Parent department ID |
| `reference_code` | string | Reference code |
| `department_hierarchy_id` | json | Array of department IDs in hierarchy |
| `parent` | json | Expanded parent department |
| `department_hierarchy` | json | Expanded department hierarchy |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Create Department [#rippling-create-department]
Create a new department
#### Input [#input-9]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `name` | string | Yes | Department name |
| `parentId` | string | No | Parent department ID |
| `referenceCode` | string | No | Reference code |
#### Output [#output-9]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Department ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `parent_id` | string | Parent department ID |
| `reference_code` | string | Reference code |
| `department_hierarchy_id` | json | Department hierarchy IDs |
| `parent` | json | Expanded parent department |
| `department_hierarchy` | json | Expanded department hierarchy |
### Rippling Update Department [#rippling-update-department]
Update an existing department
#### Input [#input-10]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Department ID |
| `name` | string | No | Department name |
| `parentId` | string | No | Parent department ID |
| `referenceCode` | string | No | Reference code |
#### Output [#output-10]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Department ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `parent_id` | string | Parent department ID |
| `reference_code` | string | Reference code |
| `department_hierarchy_id` | json | Department hierarchy IDs |
| `parent` | json | Expanded parent department |
| `department_hierarchy` | json | Expanded department hierarchy |
### Rippling List Teams [#rippling-list-teams]
List all teams
#### Input [#input-11]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `expand` | string | No | Comma-separated fields to expand |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-11]
| Parameter | Type | Description |
| - | - | - |
| `teams` | array | List of teams |
| ↳ `id` | string | Team ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Team name |
| ↳ `parent_id` | string | Parent team ID |
| ↳ `parent` | json | Expanded parent team |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Team [#rippling-get-team]
Get a specific team by ID
#### Input [#input-12]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
| `expand` | string | No | Comma-separated fields to expand |
#### Output [#output-12]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Team ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `parent_id` | string | Parent team ID |
| `parent` | json | Expanded parent team |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling List Employment Types [#rippling-list-employment-types]
List all employment types
#### Input [#input-13]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-13]
| Parameter | Type | Description |
| - | - | - |
| `employmentTypes` | array | List of employmentTypes |
| ↳ `id` | string | Employment type ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `label` | string | Employment type label |
| ↳ `name` | string | Employment type name |
| ↳ `type` | string | Type (CONTRACTOR, EMPLOYEE) |
| ↳ `compensation_time_period` | string | Compensation period (HOURLY, SALARIED) |
| ↳ `amount_worked` | string | Amount worked (PART-TIME, FULL-TIME, TEMPORARY) |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Employment Type [#rippling-get-employment-type]
Get a specific employment type by ID
#### Input [#input-14]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
#### Output [#output-14]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Employment type ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `label` | string | Label |
| `name` | string | Name |
| `type` | string | Type (CONTRACTOR, EMPLOYEE) |
| `compensation_time_period` | string | Compensation period (HOURLY, SALARIED) |
| `amount_worked` | string | Amount worked (PART-TIME, FULL-TIME, TEMPORARY) |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling List Titles [#rippling-list-titles]
List all titles
#### Input [#input-15]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-15]
| Parameter | Type | Description |
| - | - | - |
| `titles` | array | List of titles |
| ↳ `id` | string | Title ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Title name |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Title [#rippling-get-title]
Get a specific title by ID
#### Input [#input-16]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
#### Output [#output-16]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Title ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Title name |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Create Title [#rippling-create-title]
Create a new title
#### Input [#input-17]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `name` | string | Yes | Title name |
#### Output [#output-17]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Title ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Title name |
### Rippling Update Title [#rippling-update-title]
Update an existing title
#### Input [#input-18]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Title ID |
| `name` | string | No | Title name |
#### Output [#output-18]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Title ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Title name |
### Rippling Delete Title [#rippling-delete-title]
Delete a title
#### Input [#input-19]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | ID of the resource to delete |
#### Output [#output-19]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the resource was deleted |
### Rippling List Custom Fields [#rippling-list-custom-fields]
List all custom fields
#### Input [#input-20]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-20]
| Parameter | Type | Description |
| - | - | - |
| `customFields` | array | List of customFields |
| ↳ `id` | string | Custom field ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Field name |
| ↳ `description` | string | Field description |
| ↳ `required` | boolean | Whether the field is required |
| ↳ `type` | string | Field type (TEXT, DATE, NUMBER, CURRENCY, etc.) |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling List Job Functions [#rippling-list-job-functions]
List all job functions
#### Input [#input-21]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-21]
| Parameter | Type | Description |
| - | - | - |
| `jobFunctions` | array | List of jobFunctions |
| ↳ `id` | string | Job function ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Job function name |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Job Function [#rippling-get-job-function]
Get a specific job function by ID
#### Input [#input-22]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
#### Output [#output-22]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Job function ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling List Work Locations [#rippling-list-work-locations]
List all work locations
#### Input [#input-23]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-23]
| Parameter | Type | Description |
| - | - | - |
| `workLocations` | array | List of workLocations |
| ↳ `id` | string | Work location ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Location name |
| ↳ `address` | json | Address object |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Work Location [#rippling-get-work-location]
Get a specific work location by ID
#### Input [#input-24]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
#### Output [#output-24]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Location ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `address` | json | Address object |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Create Work Location [#rippling-create-work-location]
Create a new work location
#### Input [#input-25]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `name` | string | Yes | Location name |
| `streetAddress` | string | Yes | Street address |
| `locality` | string | No | City |
| `region` | string | No | State/region |
| `postalCode` | string | No | Postal code |
| `country` | string | No | Country code |
| `addressType` | string | No | Address type (HOME, WORK, OTHER) |
#### Output [#output-25]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Location ID |
| `created_at` | string | Created timestamp |
| `updated_at` | string | Updated timestamp |
| `name` | string | Name |
| `address` | json | Address |
### Rippling Update Work Location [#rippling-update-work-location]
Update a work location
#### Input [#input-26]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Location ID |
| `name` | string | No | Location name |
| `streetAddress` | string | No | Street address |
| `locality` | string | No | City |
| `region` | string | No | State/region |
| `postalCode` | string | No | Postal code |
| `country` | string | No | Country code |
| `addressType` | string | No | Address type (HOME, WORK, OTHER) |
#### Output [#output-26]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Location ID |
| `created_at` | string | Created timestamp |
| `updated_at` | string | Updated timestamp |
| `name` | string | Name |
| `address` | json | Address |
### Rippling Delete Work Location [#rippling-delete-work-location]
Delete a work location
#### Input [#input-27]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | ID of the resource to delete |
#### Output [#output-27]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the resource was deleted |
### Rippling List Business Partners [#rippling-list-business-partners]
List all business partners
#### Input [#input-28]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `filter` | string | No | Filter expression |
| `expand` | string | No | Comma-separated fields to expand |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-28]
| Parameter | Type | Description |
| - | - | - |
| `businessPartners` | array | List of businessPartners |
| ↳ `id` | string | Business partner ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `business_partner_group_id` | string | Business partner group ID |
| ↳ `worker_id` | string | Worker ID |
| ↳ `client_group_id` | string | Client group ID |
| ↳ `client_group_member_count` | number | Client group member count |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Business Partner [#rippling-get-business-partner]
Get a specific business partner by ID
#### Input [#input-29]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
| `expand` | string | No | Comma-separated fields to expand |
#### Output [#output-29]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `business_partner_group_id` | string | Group ID |
| `worker_id` | string | Worker ID |
| `client_group_id` | string | Client group ID |
| `client_group_member_count` | number | Client group member count |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Create Business Partner [#rippling-create-business-partner]
Create a new business partner
#### Input [#input-30]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `businessPartnerGroupId` | string | Yes | Business partner group ID |
| `workerId` | string | Yes | Worker ID |
#### Output [#output-30]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `business_partner_group_id` | string | Group ID |
| `worker_id` | string | Worker ID |
| `client_group_id` | string | Client group ID |
| `client_group_member_count` | number | Client group member count |
### Rippling Delete Business Partner [#rippling-delete-business-partner]
Delete a business partner
#### Input [#input-31]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | ID of the resource to delete |
#### Output [#output-31]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the resource was deleted |
### Rippling List Business Partner Groups [#rippling-list-business-partner-groups]
List all business partner groups
#### Input [#input-32]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `expand` | string | No | Comma-separated fields to expand |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-32]
| Parameter | Type | Description |
| - | - | - |
| `businessPartnerGroups` | array | List of businessPartnerGroups |
| ↳ `id` | string | Business partner group ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Group name |
| ↳ `domain` | string | Domain (HR, IT, FINANCE, RECRUITING, OTHER) |
| ↳ `default_business_partner_id` | string | Default business partner ID |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Business Partner Group [#rippling-get-business-partner-group]
Get a specific business partner group by ID
#### Input [#input-33]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
| `expand` | string | No | Comma-separated fields to expand |
#### Output [#output-33]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `domain` | string | Domain |
| `default_business_partner_id` | string | Default partner ID |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Create Business Partner Group [#rippling-create-business-partner-group]
Create a new business partner group
#### Input [#input-34]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `name` | string | Yes | Group name |
| `domain` | string | No | Domain (HR, IT, FINANCE, RECRUITING, OTHER) |
| `defaultBusinessPartnerId` | string | No | Default business partner ID |
#### Output [#output-34]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `domain` | string | Domain |
| `default_business_partner_id` | string | Default partner ID |
### Rippling Delete Business Partner Group [#rippling-delete-business-partner-group]
Delete a business partner group
#### Input [#input-35]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | ID of the resource to delete |
#### Output [#output-35]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the resource was deleted |
### Rippling List Supergroups [#rippling-list-supergroups]
List all supergroups
#### Input [#input-36]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `filter` | string | No | Filter expression (filterable fields: app\_owner\_id, group\_type) |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
#### Output [#output-36]
| Parameter | Type | Description |
| - | - | - |
| `supergroups` | array | List of supergroups |
| ↳ `id` | string | Supergroup ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `display_name` | string | Display name |
| ↳ `description` | string | Description |
| ↳ `app_owner_id` | string | App owner ID |
| ↳ `group_type` | string | Group type |
| ↳ `name` | string | Name |
| ↳ `sub_group_type` | string | Sub group type |
| ↳ `read_only` | boolean | Whether the group is read only |
| ↳ `parent` | string | Parent group ID |
| ↳ `mutually_exclusive_key` | string | Mutually exclusive key |
| ↳ `cumulatively_exhaustive_default` | boolean | Whether the group is the cumulatively exhaustive default |
| ↳ `include_terminated` | boolean | Whether the group includes terminated roles |
| ↳ `allow_non_employees` | boolean | Whether the group allows non-employees |
| ↳ `can_override_role_states` | boolean | Whether the group can override role states |
| ↳ `priority` | number | Group priority |
| ↳ `is_invisible` | boolean | Whether the group is invisible |
| ↳ `ignore_prov_group_matching` | boolean | Whether to ignore provisioning group matching |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Supergroup [#rippling-get-supergroup]
Get a specific supergroup by ID
#### Input [#input-37]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
#### Output [#output-37]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Supergroup ID |
| `created_at` | string | Record creation date |
| `updated_at` | string | Record update date |
| `display_name` | string | Display name |
| `description` | string | Description |
| `app_owner_id` | string | App owner ID |
| `group_type` | string | Group type |
| `name` | string | Name |
| `sub_group_type` | string | Sub group type |
| `read_only` | boolean | Whether the group is read only |
| `parent` | string | Parent group ID |
| `mutually_exclusive_key` | string | Mutually exclusive key |
| `cumulatively_exhaustive_default` | boolean | Whether the group is the cumulatively exhaustive default |
| `include_terminated` | boolean | Whether the group includes terminated roles |
| `allow_non_employees` | boolean | Whether the group allows non-employees |
| `can_override_role_states` | boolean | Whether the group can override role states |
| `priority` | number | Group priority |
| `is_invisible` | boolean | Whether the group is invisible |
| `ignore_prov_group_matching` | boolean | Whether to ignore provisioning group matching |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling List Supergroup Members [#rippling-list-supergroup-members]
List members of a supergroup
#### Input [#input-38]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `groupId` | string | Yes | Supergroup ID |
| `expand` | string | No | Fields to expand (e.g., worker) |
| `orderBy` | string | No | Sort field |
#### Output [#output-38]
| Parameter | Type | Description |
| - | - | - |
| `members` | array | List of members |
| ↳ `id` | string | Member ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `full_name` | string | Full name |
| ↳ `work_email` | string | Work email |
| ↳ `worker_id` | string | Worker ID |
| ↳ `worker` | json | Expanded worker object |
| `totalCount` | number | Number of members returned |
| `nextLink` | string | Next page link |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling List Supergroup Inclusion Members [#rippling-list-supergroup-inclusion-members]
List inclusion members of a supergroup
#### Input [#input-39]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `groupId` | string | Yes | Supergroup ID |
| `expand` | string | No | Fields to expand (e.g., worker) |
| `orderBy` | string | No | Sort field |
#### Output [#output-39]
| Parameter | Type | Description |
| - | - | - |
| `members` | array | List of members |
| ↳ `id` | string | Member ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `full_name` | string | Full name |
| ↳ `work_email` | string | Work email |
| ↳ `worker_id` | string | Worker ID |
| ↳ `worker` | json | Expanded worker object |
| `totalCount` | number | Number of members returned |
| `nextLink` | string | Next page link |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling List Supergroup Exclusion Members [#rippling-list-supergroup-exclusion-members]
List exclusion members of a supergroup
#### Input [#input-40]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `groupId` | string | Yes | Supergroup ID |
| `expand` | string | No | Fields to expand (e.g., worker) |
| `orderBy` | string | No | Sort field |
#### Output [#output-40]
| Parameter | Type | Description |
| - | - | - |
| `members` | array | List of members |
| ↳ `id` | string | Member ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `full_name` | string | Full name |
| ↳ `work_email` | string | Work email |
| ↳ `worker_id` | string | Worker ID |
| ↳ `worker` | json | Expanded worker object |
| `totalCount` | number | Number of members returned |
| `nextLink` | string | Next page link |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Update Supergroup Inclusion Members [#rippling-update-supergroup-inclusion-members]
Update inclusion members of a supergroup
#### Input [#input-41]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `groupId` | string | Yes | Supergroup ID |
| `operations` | json | Yes | Operations array \[\{op: "add"\|"remove", value: \[\{id: "member\_id"}]}] |
#### Output [#output-41]
| Parameter | Type | Description |
| - | - | - |
| `ok` | boolean | Whether the operation succeeded |
### Rippling Update Supergroup Exclusion Members [#rippling-update-supergroup-exclusion-members]
Update exclusion members of a supergroup
#### Input [#input-42]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `groupId` | string | Yes | Supergroup ID |
| `operations` | json | Yes | Operations array \[\{op: "add"\|"remove", value: \[\{id: "member\_id"}]}] |
#### Output [#output-42]
| Parameter | Type | Description |
| - | - | - |
| `ok` | boolean | Whether the operation succeeded |
### Rippling List Custom Objects [#rippling-list-custom-objects]
List all custom objects
#### Input [#input-43]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
#### Output [#output-43]
| Parameter | Type | Description |
| - | - | - |
| `customObjects` | array | List of customObjects |
| ↳ `id` | string | Custom object ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Object name |
| ↳ `description` | string | Description |
| ↳ `api_name` | string | API name |
| ↳ `plural_label` | string | Plural label |
| ↳ `category_id` | string | Category ID |
| ↳ `native_category_id` | string | Native category ID |
| ↳ `managed_package_install_id` | string | Package install ID |
| ↳ `owner_id` | string | Owner ID |
| ↳ `enable_history` | boolean | Whether history is enabled |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
### Rippling Get Custom Object [#rippling-get-custom-object]
Get a custom object by API name
#### Input [#input-44]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | custom object api name |
#### Output [#output-44]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `description` | string | Description |
| `api_name` | string | API name |
| `plural_label` | string | Plural label |
| `category_id` | string | Category ID |
| `enable_history` | boolean | History enabled |
| `native_category_id` | string | Native category ID |
| `managed_package_install_id` | string | Package install ID |
| `owner_id` | string | Owner ID |
### Rippling Create Custom Object [#rippling-create-custom-object]
Create a new custom object
#### Input [#input-45]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `name` | string | Yes | Object name |
| `description` | string | No | Description |
| `category` | string | No | Category |
#### Output [#output-45]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `description` | string | Description |
| `api_name` | string | API name |
| `plural_label` | string | Plural label |
| `category_id` | string | Category ID |
| `enable_history` | boolean | History enabled |
| `native_category_id` | string | Native category ID |
| `managed_package_install_id` | string | Package install ID |
| `owner_id` | string | Owner ID |
### Rippling Update Custom Object [#rippling-update-custom-object]
Update a custom object
#### Input [#input-46]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `name` | string | No | Name |
| `description` | string | No | Description |
| `category` | string | No | Category |
| `pluralLabel` | string | No | Plural label |
| `ownerRole` | string | No | Owner role |
#### Output [#output-46]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `description` | string | Description |
| `api_name` | string | API name |
| `plural_label` | string | Plural label |
| `category_id` | string | Category ID |
| `enable_history` | boolean | History enabled |
| `native_category_id` | string | Native category ID |
| `managed_package_install_id` | string | Package install ID |
| `owner_id` | string | Owner ID |
### Rippling Delete Custom Object [#rippling-delete-custom-object]
Delete a custom object
#### Input [#input-47]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | ID of the resource to delete |
#### Output [#output-47]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the resource was deleted |
### Rippling List Custom Object Fields [#rippling-list-custom-object-fields]
List all fields for a custom object
#### Input [#input-48]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
#### Output [#output-48]
| Parameter | Type | Description |
| - | - | - |
| `fields` | array | List of fields |
| ↳ `id` | string | Field ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Field name |
| ↳ `custom_object` | string | Parent custom object |
| ↳ `description` | string | Description |
| ↳ `api_name` | string | API name |
| ↳ `data_type` | json | Data type configuration |
| ↳ `is_unique` | boolean | Whether the field is unique |
| ↳ `is_immutable` | boolean | Whether the field is immutable |
| ↳ `is_standard` | boolean | Whether the field is standard |
| ↳ `enable_history` | boolean | Whether history is enabled |
| ↳ `managed_package_install_id` | string | Package install ID |
| `totalCount` | number | Number of fields returned |
| `nextLink` | string | Next page link |
### Rippling Get Custom Object Field [#rippling-get-custom-object-field]
Get a specific field of a custom object
#### Input [#input-49]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `fieldApiName` | string | Yes | Field API name |
#### Output [#output-49]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Field ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `custom_object` | string | Custom object |
| `description` | string | Description |
| `api_name` | string | API name |
| `data_type` | json | Data type configuration |
| `is_unique` | boolean | Is unique |
| `is_immutable` | boolean | Is immutable |
| `is_standard` | boolean | Is standard |
| `enable_history` | boolean | History enabled |
| `managed_package_install_id` | string | Package install ID |
### Rippling Create Custom Object Field [#rippling-create-custom-object-field]
Create a field on a custom object
#### Input [#input-50]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `name` | string | Yes | Field name |
| `description` | string | No | Description |
| `dataType` | json | Yes | Data type configuration |
| `required` | boolean | No | Whether the field is required |
| `rqlDefinition` | json | No | RQL definition object |
| `isUnique` | boolean | No | Whether field is unique |
| `formulaAttrMetas` | json | No | Formula attribute metadata |
| `section` | json | No | Section configuration |
| `enableHistory` | boolean | No | Enable history tracking |
| `derivedFieldFormula` | string | No | Derived field formula expression |
| `derivedAggregatedField` | json | No | Derived aggregated field configuration |
#### Output [#output-50]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Field ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `custom_object` | string | Custom object |
| `description` | string | Description |
| `api_name` | string | API name |
| `data_type` | json | Data type configuration |
| `is_unique` | boolean | Is unique |
| `is_immutable` | boolean | Is immutable |
| `is_standard` | boolean | Is standard |
| `enable_history` | boolean | History enabled |
| `managed_package_install_id` | string | Package install ID |
### Rippling Update Custom Object Field [#rippling-update-custom-object-field]
Update a field on a custom object
#### Input [#input-51]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `fieldApiName` | string | Yes | Field API name |
| `name` | string | No | Field name |
| `description` | string | No | Description |
| `dataType` | json | No | Data type |
| `required` | boolean | No | Whether the field is required |
| `rqlDefinition` | json | No | RQL definition object |
| `isUnique` | boolean | No | Is unique |
| `formulaAttrMetas` | json | No | Formula attribute metadata |
| `section` | json | No | Section configuration |
| `enableHistory` | boolean | No | Enable history |
| `derivedFieldFormula` | string | No | Derived field formula expression |
| `nameFieldDetails` | json | No | Name field details configuration |
#### Output [#output-51]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Field ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `custom_object` | string | Custom object |
| `description` | string | Description |
| `api_name` | string | API name |
| `data_type` | json | Data type configuration |
| `is_unique` | boolean | Is unique |
| `is_immutable` | boolean | Is immutable |
| `is_standard` | boolean | Is standard |
| `enable_history` | boolean | History enabled |
| `managed_package_install_id` | string | Package install ID |
### Rippling Delete Custom Object Field [#rippling-delete-custom-object-field]
Delete a field from a custom object
#### Input [#input-52]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `fieldApiName` | string | Yes | Field API name |
#### Output [#output-52]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the field was deleted |
### Rippling List Custom Object Records [#rippling-list-custom-object-records]
List all records for a custom object
#### Input [#input-53]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
#### Output [#output-53]
| Parameter | Type | Description |
| - | - | - |
| `records` | array | List of records |
| ↳ `id` | string | Record ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Record name |
| ↳ `external_id` | string | External ID |
| ↳ `created_by` | json | Created by user (id, display\_value, image) |
| ↳ `last_modified_by` | json | Last modified by user (id, display\_value, image) |
| ↳ `owner_role` | json | Owner role (id, display\_value, image) |
| ↳ `system_updated_at` | string | System update timestamp |
| ↳ `data` | json | Full record data including dynamic fields |
| `totalCount` | number | Number of records returned |
| `nextLink` | string | Next page link |
### Rippling Get Custom Object Record [#rippling-get-custom-object-record]
Get a specific custom object record
#### Input [#input-54]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `codrId` | string | Yes | Record ID |
#### Output [#output-54]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Record ID |
| `created_at` | string | Record creation date |
| `updated_at` | string | Record update date |
| `name` | string | Record name |
| `external_id` | string | External ID |
| `created_by` | json | Created by user (id, display\_value, image) |
| `last_modified_by` | json | Last modified by user (id, display\_value, image) |
| `owner_role` | json | Owner role (id, display\_value, image) |
| `system_updated_at` | string | System update timestamp |
| `data` | json | Full record data |
### Rippling Get Record By External ID [#rippling-get-record-by-external-id]
Get a custom object record by external ID
#### Input [#input-55]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `externalId` | string | Yes | External ID |
#### Output [#output-55]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Record ID |
| `created_at` | string | Record creation date |
| `updated_at` | string | Record update date |
| `name` | string | Record name |
| `external_id` | string | External ID |
| `created_by` | json | Created by user (id, display\_value, image) |
| `last_modified_by` | json | Last modified by user (id, display\_value, image) |
| `owner_role` | json | Owner role (id, display\_value, image) |
| `system_updated_at` | string | System update timestamp |
| `data` | json | Full record data |
### Rippling Query Custom Object Records [#rippling-query-custom-object-records]
Query custom object records with filters
#### Input [#input-56]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `query` | string | No | Query expression |
| `limit` | number | No | Maximum number of records to return |
| `cursor` | string | No | Pagination cursor |
#### Output [#output-56]
| Parameter | Type | Description |
| - | - | - |
| `records` | array | Matching records |
| ↳ `id` | string | Record ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Record name |
| ↳ `external_id` | string | External ID |
| ↳ `created_by` | json | Created by user (id, display\_value, image) |
| ↳ `last_modified_by` | json | Last modified by user (id, display\_value, image) |
| ↳ `owner_role` | json | Owner role (id, display\_value, image) |
| ↳ `system_updated_at` | string | System update timestamp |
| ↳ `data` | json | Full record data |
| `totalCount` | number | Number of records returned |
| `cursor` | string | Cursor for next page of results |
### Rippling Create Custom Object Record [#rippling-create-custom-object-record]
Create a custom object record
#### Input [#input-57]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `externalId` | string | No | External ID for the record |
| `data` | json | Yes | Record data |
#### Output [#output-57]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Record ID |
| `created_at` | string | Record creation date |
| `updated_at` | string | Record update date |
| `name` | string | Record name |
| `external_id` | string | External ID |
| `created_by` | json | Created by user (id, display\_value, image) |
| `last_modified_by` | json | Last modified by user (id, display\_value, image) |
| `owner_role` | json | Owner role (id, display\_value, image) |
| `system_updated_at` | string | System update timestamp |
| `data` | json | Full record data |
### Rippling Update Custom Object Record [#rippling-update-custom-object-record]
Update a custom object record
#### Input [#input-58]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `codrId` | string | Yes | Record ID |
| `externalId` | string | No | External ID for the record |
| `data` | json | No | Updated record data |
#### Output [#output-58]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Record ID |
| `created_at` | string | Record creation date |
| `updated_at` | string | Record update date |
| `name` | string | Record name |
| `external_id` | string | External ID |
| `created_by` | json | Created by user (id, display\_value, image) |
| `last_modified_by` | json | Last modified by user (id, display\_value, image) |
| `owner_role` | json | Owner role (id, display\_value, image) |
| `system_updated_at` | string | System update timestamp |
| `data` | json | Full record data |
### Rippling Delete Custom Object Record [#rippling-delete-custom-object-record]
Delete a custom object record
#### Input [#input-59]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `codrId` | string | Yes | Record ID |
#### Output [#output-59]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the record was deleted |
### Rippling Bulk Create Custom Object Records [#rippling-bulk-create-custom-object-records]
Bulk create custom object records
#### Input [#input-60]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `rowsToWrite` | json | Yes | Array of records to create \[\{external\_id?, data}] |
| `allOrNothing` | boolean | No | If true, fail entire batch on any error |
#### Output [#output-60]
| Parameter | Type | Description |
| - | - | - |
| `createdRecords` | array | Created custom object records |
| `totalCount` | number | Number of records created |
### Rippling Bulk Update Custom Object Records [#rippling-bulk-update-custom-object-records]
Bulk update custom object records
#### Input [#input-61]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `rowsToUpdate` | json | Yes | Array of records to update |
| `allOrNothing` | boolean | No | If true, fail entire batch on any error |
#### Output [#output-61]
| Parameter | Type | Description |
| - | - | - |
| `updatedRecords` | array | Updated custom object records |
| `totalCount` | number | Number of records updated |
### Rippling Bulk Delete Custom Object Records [#rippling-bulk-delete-custom-object-records]
Bulk delete custom object records
#### Input [#input-62]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `customObjectApiName` | string | Yes | Custom object API name |
| `rowsToDelete` | json | Yes | Array of records to delete |
| `allOrNothing` | boolean | No | If true, fail entire batch on any error |
#### Output [#output-62]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the bulk delete succeeded |
### Rippling List CustomApps [#rippling-list-customapps]
List all custom apps
#### Input [#input-63]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
#### Output [#output-63]
| Parameter | Type | Description |
| - | - | - |
| `customApps` | array | List of customApps |
| ↳ `id` | string | App ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | App name |
| ↳ `api_name` | string | API name |
| ↳ `description` | string | Description |
| ↳ `icon` | string | Icon URL |
| ↳ `pages` | json | Array of page summaries |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get CustomApp [#rippling-get-customapp]
Get a specific custom app
#### Input [#input-64]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
#### Output [#output-64]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | App ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `api_name` | string | API name |
| `description` | string | Description |
| `icon` | string | Icon URL |
| `pages` | json | Array of page summaries |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Create Custom App [#rippling-create-custom-app]
Create a new custom app
#### Input [#input-65]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `name` | string | Yes | App name |
| `apiName` | string | Yes | API name |
| `description` | string | No | Description |
#### Output [#output-65]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | App ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `api_name` | string | API name |
| `description` | string | Description |
| `icon` | string | Icon URL |
| `pages` | json | Array of page summaries |
### Rippling Update CustomApp [#rippling-update-customapp]
Update a custom app
#### Input [#input-66]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | App ID |
| `name` | string | No | App name |
| `apiName` | string | No | API name |
| `description` | string | No | Description |
#### Output [#output-66]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | App ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `api_name` | string | API name |
| `description` | string | Description |
| `icon` | string | Icon URL |
| `pages` | json | Array of page summaries |
### Rippling Delete CustomApp [#rippling-delete-customapp]
Delete a custom app
#### Input [#input-67]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | ID of the resource to delete |
#### Output [#output-67]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the resource was deleted |
### Rippling List CustomPages [#rippling-list-custompages]
List all custom pages
#### Input [#input-68]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
#### Output [#output-68]
| Parameter | Type | Description |
| - | - | - |
| `customPages` | array | List of customPages |
| ↳ `id` | string | Page ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Page name |
| ↳ `components` | json | Page components |
| ↳ `actions` | json | Page actions |
| ↳ `canvas_actions` | json | Canvas actions |
| ↳ `variables` | json | Page variables |
| ↳ `media` | json | Page media |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get CustomPage [#rippling-get-custompage]
Get a specific custom page
#### Input [#input-69]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
#### Output [#output-69]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Page ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `components` | json | Page components |
| `actions` | json | Page actions |
| `canvas_actions` | json | Canvas actions |
| `variables` | json | Page variables |
| `media` | json | Page media |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Create CustomPage [#rippling-create-custompage]
Create a new custom page
#### Input [#input-70]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `name` | string | Yes | Page name |
#### Output [#output-70]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Page ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `components` | json | Page components |
| `actions` | json | Page actions |
| `canvas_actions` | json | Canvas actions |
| `variables` | json | Page variables |
| `media` | json | Page media |
### Rippling Update CustomPage [#rippling-update-custompage]
Update a custom page
#### Input [#input-71]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Page ID |
| `name` | string | No | Page name |
#### Output [#output-71]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Page ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `components` | json | Page components |
| `actions` | json | Page actions |
| `canvas_actions` | json | Canvas actions |
| `variables` | json | Page variables |
| `media` | json | Page media |
### Rippling Delete CustomPage [#rippling-delete-custompage]
Delete a custom page
#### Input [#input-72]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | ID of the resource to delete |
#### Output [#output-72]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the resource was deleted |
### Rippling List Custom Settings [#rippling-list-custom-settings]
List all custom settings
#### Input [#input-73]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `orderBy` | string | No | Sort field. Prefix with - for descending |
| `cursor` | string | No | Pagination cursor from previous response |
#### Output [#output-73]
| Parameter | Type | Description |
| - | - | - |
| `customSettings` | array | List of custom settings |
| ↳ `id` | string | Setting ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `display_name` | string | Display name |
| ↳ `api_name` | string | API name |
| ↳ `data_type` | string | Data type |
| ↳ `secret_value` | string | Secret value |
| ↳ `string_value` | string | String value |
| ↳ `number_value` | number | Number value |
| ↳ `boolean_value` | boolean | Boolean value |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Get Custom Setting [#rippling-get-custom-setting]
Get a specific custom setting
#### Input [#input-74]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
#### Output [#output-74]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Setting ID |
| `created_at` | string | Record creation date |
| `updated_at` | string | Record update date |
| `display_name` | string | Display name |
| `api_name` | string | API name |
| `data_type` | string | Data type |
| `secret_value` | string | Secret value |
| `string_value` | string | String value |
| `number_value` | number | Number value |
| `boolean_value` | boolean | Boolean value |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Create Custom Setting [#rippling-create-custom-setting]
Create a new custom setting
#### Input [#input-75]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `displayName` | string | No | Display name |
| `apiName` | string | No | Unique API name |
| `dataType` | string | No | Data type of the setting |
| `secretValue` | string | No | Secret value (for secret data type) |
| `stringValue` | string | No | String value (for string data type) |
| `numberValue` | number | No | Number value (for number data type) |
| `booleanValue` | boolean | No | Boolean value (for boolean data type) |
#### Output [#output-75]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Setting ID |
| `created_at` | string | Record creation date |
| `updated_at` | string | Record update date |
| `display_name` | string | Display name |
| `api_name` | string | API name |
| `data_type` | string | Data type |
| `secret_value` | string | Secret value |
| `string_value` | string | String value |
| `number_value` | number | Number value |
| `boolean_value` | boolean | Boolean value |
### Rippling Update Custom Setting [#rippling-update-custom-setting]
Update a custom setting
#### Input [#input-76]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Setting ID |
| `displayName` | string | No | Display name |
| `apiName` | string | No | Unique API name |
| `dataType` | string | No | Data type of the setting |
| `secretValue` | string | No | Secret value (for secret data type) |
| `stringValue` | string | No | String value (for string data type) |
| `numberValue` | number | No | Number value (for number data type) |
| `booleanValue` | boolean | No | Boolean value (for boolean data type) |
#### Output [#output-76]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Setting ID |
| `created_at` | string | Record creation date |
| `updated_at` | string | Record update date |
| `display_name` | string | Display name |
| `api_name` | string | API name |
| `data_type` | string | Data type |
| `secret_value` | string | Secret value |
| `string_value` | string | String value |
| `number_value` | number | Number value |
| `boolean_value` | boolean | Boolean value |
### Rippling Delete Custom Setting [#rippling-delete-custom-setting]
Delete a custom setting
#### Input [#input-77]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | ID of the resource to delete |
#### Output [#output-77]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the resource was deleted |
### Rippling List Object Categories [#rippling-list-object-categories]
List all object categories
#### Input [#input-78]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
#### Output [#output-78]
| Parameter | Type | Description |
| - | - | - |
| `objectCategories` | array | List of objectCategories |
| ↳ `id` | string | Category ID |
| ↳ `created_at` | string | Record creation date |
| ↳ `updated_at` | string | Record update date |
| ↳ `name` | string | Category name |
| ↳ `description` | string | Description |
| `totalCount` | number | Number of items returned |
| `nextLink` | string | Link to next page of results |
### Rippling Get ObjectCategory [#rippling-get-objectcategory]
Get a specific object category
#### Input [#input-79]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Resource ID |
#### Output [#output-79]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Category ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `description` | string | Description |
### Rippling Create ObjectCategory [#rippling-create-objectcategory]
Create a new object category
#### Input [#input-80]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `name` | string | Yes | Category name |
| `description` | string | No | Description |
#### Output [#output-80]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Category ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `description` | string | Description |
### Rippling Update ObjectCategory [#rippling-update-objectcategory]
Update an object category
#### Input [#input-81]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | Category ID |
| `name` | string | No | Category name |
| `description` | string | No | Description |
#### Output [#output-81]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Category ID |
| `created_at` | string | Creation date |
| `updated_at` | string | Update date |
| `name` | string | Name |
| `description` | string | Description |
### Rippling Delete ObjectCategory [#rippling-delete-objectcategory]
Delete an object category
#### Input [#input-82]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `id` | string | Yes | ID of the resource to delete |
#### Output [#output-82]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the resource was deleted |
### Rippling Get Report Run [#rippling-get-report-run]
Get a report run by ID
#### Input [#input-83]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `runId` | string | Yes | run id |
#### Output [#output-83]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Report run ID |
| `report_id` | string | Report ID |
| `status` | string | Run status |
| `file_url` | string | URL to download the report file |
| `expires_at` | string | Expiration timestamp for the file URL |
| `output_type` | string | Output format (JSON or CSV) |
| `__meta` | json | Metadata including redacted\_fields |
### Rippling Trigger Report Run [#rippling-trigger-report-run]
Trigger a new report run
#### Input [#input-84]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `reportId` | string | Yes | Report ID to run |
| `includeObjectIds` | boolean | No | Include object IDs in the report |
| `includeTotalRows` | boolean | No | Include total row count |
| `formatDateFields` | json | No | Date field formatting configuration |
| `formatCurrencyFields` | json | No | Currency field formatting configuration |
| `outputType` | string | No | Output type (JSON or CSV) |
#### Output [#output-84]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Report run ID |
| `report_id` | string | Report ID |
| `status` | string | Run status |
| `file_url` | string | URL to download the report file |
| `expires_at` | string | Expiration timestamp for the file URL |
| `output_type` | string | Output format (JSON or CSV) |
### Rippling Create Draft Hires [#rippling-create-draft-hires]
Create bulk draft hires
#### Input [#input-85]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Rippling API key |
| `draftHires` | json | Yes | Array of draft hire objects |
#### Output [#output-85]
| Parameter | Type | Description |
| - | - | - |
| `invalidItems` | json | Failed draft hires |
| `successfulResults` | json | Successful draft hires |
| `totalInvalid` | number | Number of failures |
| `totalSuccessful` | number | Number of successes |