Rippling

Use Rippling 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.

Use the block

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

Rippling List Workers

List all workers with optional filtering and pagination

Inputs and outputs

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

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

Get a specific worker by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID
`expand`	string	No	Comma-separated fields to expand

Output

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

List all users with optional pagination

Inputs and outputs

Input

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

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

Get a specific user by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID

Output

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

List all companies

Inputs and outputs

Input

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

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

Get SSO information for the current user

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`expand`	string	No	Comma-separated fields to expand

Output

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

List all entitlements

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key

Output

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

List all departments

Inputs and outputs

Input

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

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

Get a specific department by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID
`expand`	string	No	Comma-separated fields to expand

Output

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

Create a new department

Inputs and outputs

Input

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

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

Update an existing department

Inputs and outputs

Input

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

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

List all teams

Inputs and outputs

Input

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

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

Get a specific team by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID
`expand`	string	No	Comma-separated fields to expand

Output

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

List all employment types

Inputs and outputs

Input

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

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

Get a specific employment type by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID

Output

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

List all titles

Inputs and outputs

Input

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

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

Get a specific title by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID

Output

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

Create a new title

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`name`	string	Yes	Title name

Output

Parameter	Type	Description
`id`	string	Title ID
`created_at`	string	Creation date
`updated_at`	string	Update date
`name`	string	Title name

Rippling Update Title

Update an existing title

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Title ID
`name`	string	No	Title name

Output

Parameter	Type	Description
`id`	string	Title ID
`created_at`	string	Creation date
`updated_at`	string	Update date
`name`	string	Title name

Rippling Delete Title

Delete a title

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	ID of the resource to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the resource was deleted

Rippling List Custom Fields

List all custom fields

Inputs and outputs

Input

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

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

List all job functions

Inputs and outputs

Input

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

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

Get a specific job function by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID

Output

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

List all work locations

Inputs and outputs

Input

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

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

Get a specific work location by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID

Output

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

Create a new work location

Inputs and outputs

Input

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

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

Update a work location

Inputs and outputs

Input

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

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

Delete a work location

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	ID of the resource to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the resource was deleted

Rippling List Business Partners

List all business partners

Inputs and outputs

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

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

Get a specific business partner by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID
`expand`	string	No	Comma-separated fields to expand

Output

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

Create a new business partner

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`businessPartnerGroupId`	string	Yes	Business partner group ID
`workerId`	string	Yes	Worker ID

Output

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

Delete a business partner

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	ID of the resource to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the resource was deleted

Rippling List Business Partner Groups

List all business partner groups

Inputs and outputs

Input

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

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

Get a specific business partner group by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID
`expand`	string	No	Comma-separated fields to expand

Output

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

Create a new business partner group

Inputs and outputs

Input

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

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

Delete a business partner group

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	ID of the resource to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the resource was deleted

Rippling List Supergroups

List all supergroups

Inputs and outputs

Input

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

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

Get a specific supergroup by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID

Output

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

List members of a supergroup

Inputs and outputs

Input

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

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

List inclusion members of a supergroup

Inputs and outputs

Input

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

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

List exclusion members of a supergroup

Inputs and outputs

Input

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

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

Update inclusion members of a supergroup

Inputs and outputs

Input

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

Parameter	Type	Description
`ok`	boolean	Whether the operation succeeded

Rippling Update Supergroup Exclusion Members

Update exclusion members of a supergroup

Inputs and outputs

Input

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

Parameter	Type	Description
`ok`	boolean	Whether the operation succeeded

Rippling List Custom Objects

List all custom objects

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key

Output

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

Get a custom object by API name

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`customObjectApiName`	string	Yes	custom object api name

Output

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

Create a new custom object

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`name`	string	Yes	Object name
`description`	string	No	Description
`category`	string	No	Category

Output

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

Update a custom object

Inputs and outputs

Input

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

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

Delete a custom object

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`customObjectApiName`	string	Yes	ID of the resource to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the resource was deleted

Rippling List Custom Object Fields

List all fields for a custom object

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`customObjectApiName`	string	Yes	Custom object API name

Output

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

Get a specific field of a custom object

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`customObjectApiName`	string	Yes	Custom object API name
`fieldApiName`	string	Yes	Field API name

Output

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

Create a field on a custom object

Inputs and outputs

Input

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

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

Update a field on a custom object

Inputs and outputs

Input

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

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

Delete a field from a custom object

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`customObjectApiName`	string	Yes	Custom object API name
`fieldApiName`	string	Yes	Field API name

Output

Parameter	Type	Description
`deleted`	boolean	Whether the field was deleted

Rippling List Custom Object Records

List all records for a custom object

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`customObjectApiName`	string	Yes	Custom object API name

Output

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

Get a specific custom object record

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`customObjectApiName`	string	Yes	Custom object API name
`codrId`	string	Yes	Record ID

Output

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

Get a custom object record by external ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`customObjectApiName`	string	Yes	Custom object API name
`externalId`	string	Yes	External ID

Output

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

Query custom object records with filters

Inputs and outputs

Input

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

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

Create a custom object record

Inputs and outputs

Input

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

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

Update a custom object record

Inputs and outputs

Input

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

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

Delete a custom object record

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`customObjectApiName`	string	Yes	Custom object API name
`codrId`	string	Yes	Record ID

Output

Parameter	Type	Description
`deleted`	boolean	Whether the record was deleted

Rippling Bulk Create Custom Object Records

Bulk create custom object records

Inputs and outputs

Input

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

Parameter	Type	Description
`createdRecords`	array	Created custom object records
`totalCount`	number	Number of records created

Rippling Bulk Update Custom Object Records

Bulk update custom object records

Inputs and outputs

Input

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

Parameter	Type	Description
`updatedRecords`	array	Updated custom object records
`totalCount`	number	Number of records updated

Rippling Bulk Delete Custom Object Records

Bulk delete custom object records

Inputs and outputs

Input

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

Parameter	Type	Description
`deleted`	boolean	Whether the bulk delete succeeded

Rippling List CustomApps

List all custom apps

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key

Output

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

Get a specific custom app

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID

Output

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

Create a new custom app

Inputs and outputs

Input

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

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

Update a custom app

Inputs and outputs

Input

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

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

Delete a custom app

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	ID of the resource to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the resource was deleted

Rippling List CustomPages

List all custom pages

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key

Output

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

Get a specific custom page

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID

Output

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

Create a new custom page

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`name`	string	Yes	Page name

Output

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

Update a custom page

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Page ID
`name`	string	No	Page name

Output

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

Delete a custom page

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	ID of the resource to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the resource was deleted

Rippling List Custom Settings

List all custom settings

Inputs and outputs

Input

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

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

Get a specific custom setting

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID

Output

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

Create a new custom setting

Inputs and outputs

Input

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

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

Update a custom setting

Inputs and outputs

Input

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

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

Delete a custom setting

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	ID of the resource to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the resource was deleted

Rippling List Object Categories

List all object categories

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key

Output

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

Get a specific object category

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	Resource ID

Output

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

Create a new object category

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`name`	string	Yes	Category name
`description`	string	No	Description

Output

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

Update an object category

Inputs and outputs

Input

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

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

Delete an object category

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`id`	string	Yes	ID of the resource to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the resource was deleted

Rippling Get Report Run

Get a report run by ID

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`runId`	string	Yes	run id

Output

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

Trigger a new report run

Inputs and outputs

Input

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

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

Create bulk draft hires

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Rippling API key
`draftHires`	json	Yes	Array of draft hire objects

Output

Parameter	Type	Description
`invalidItems`	json	Failed draft hires
`successfulResults`	json	Successful draft hires
`totalInvalid`	number	Number of failures
`totalSuccessful`	number	Number of successes