AACFlow

Rippling

Mitarbeiter, Abteilungen, benutzerdefinierte Objekte und Unternehmensdaten in Rippling verwalten

Rippling is a unified workforce management platform that brings together HR, IT, and Finance into a single system. Rippling lets companies manage payroll, benefits, devices, apps, and more — all from one place — while automating the tedious manual work that typically bogs down HR teams. Its Platform REST API provides programmatic access to workers, users, departments, teams, custom objects, business partners, supergroups, and more.

Why Rippling?

  • Comprehensive Workforce Data: Access workers, users, companies, entitlements, departments, teams, titles, employment types, job functions, work locations, and custom fields — your complete organizational graph in one API.
  • Custom Objects Platform: Create, manage, and query custom objects with typed fields, records, and bulk operations — extend Rippling's data model to fit your business.
  • Business Partner Management: Track vendors, contractors, and external partners with full CRUD operations and grouping support via business partner groups.
  • Supergroup Access Control: Manage dynamic permission groups with granular inclusion and exclusion member lists for fine-grained access control.
  • Platform Extensibility: Build custom apps, pages, settings, and object categories that live natively inside Rippling's UI.
  • Automated Reporting: Trigger report runs programmatically and poll for results to build fully automated reporting pipelines.

Using Rippling in AACFlow

AACFlow's Rippling integration connects your agentic workflows directly to your Rippling account using an API key. With 86 operations spanning workers, users, departments, teams, titles, work locations, business partners, supergroups, custom objects, custom apps, custom pages, custom settings, object categories, reports, and draft hires, you can build powerful HR and platform automations without writing backend code.

Key benefits of using Rippling in AACFlow:

  • Worker and user management: List, search, and retrieve worker and user details to power onboarding checklists, offboarding workflows, and org chart updates.
  • Organizational intelligence: Query departments, teams, titles, employment types, job functions, work locations, and custom fields to build dynamic org reports or trigger actions based on structural changes.
  • Custom object automation: Create custom objects, define fields, and manage records — including bulk create, update, and delete operations — to extend Rippling's data model for your workflows.
  • Business partner workflows: Manage vendors and external partners with full lifecycle operations including grouping and categorization.
  • Platform app development: Create and manage custom apps, pages, settings, and object categories that extend Rippling's native functionality.
  • Report automation: Trigger report runs and poll for results to build automated reporting pipelines without manual intervention.
  • Draft hire onboarding: Push one or more draft hires into Rippling's onboarding flow in a single call, complete with all required employee data.

Whether you're automating new hire onboarding, managing custom object data, building organizational reports, or extending Rippling's platform with custom apps, Rippling in AACFlow gives you direct, secure access to the full Rippling Platform REST API — no middleware required. AACFlowply configure your API key, select the operation you need, and let AACFlow handle the rest.

Nutzungsanleitung

Integrate Rippling Platform into your workflow. 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.

Tools

rippling_list_workers

List all workers with optional filtering and pagination

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
filterstringNeinFilter expression
expandstringNeinComma-separated fields to expand
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
workersarrayList of workers
idstringWorker ID
created_atstringRecord creation date
updated_atstringRecord update date
user_idstringAssociated user ID
is_managerbooleanWhether the worker is a manager
manager_idstringManager worker ID
legal_entity_idstringLegal entity ID
countrystringWorker country code
start_datestringEmployment start date
end_datestringEmployment end date
numbernumberWorker number
work_emailstringWork email address
personal_emailstringPersonal email address
statusstringWorker status (INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED)
employment_type_idstringEmployment type ID
department_idstringDepartment ID
teams_idjsonArray of team IDs
titlestringJob title
level_idstringLevel ID
compensation_idstringCompensation ID
overtime_exemptionstringOvertime exemption status (EXEMPT, NON_EXEMPT)
title_effective_datestringTitle effective date
business_partners_idjsonArray of business partner IDs
locationjsonWorker location (type, work_location_id)
genderstringGender
date_of_birthstringDate of birth
racestringRace
ethnicitystringEthnicity
citizenshipstringCitizenship country code
termination_detailsjsonTermination details
custom_fieldsjsonCustom fields (expandable)
country_fieldsjsonCountry-specific fields
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_worker

Get a specific worker by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
expandstringNeinComma-separated fields to expand

Ausgabe

ParameterTypBeschreibung
idstringWorker ID
created_atstringCreation date
updated_atstringUpdate date
user_idstringUser ID
is_managerbooleanIs manager
manager_idstringManager ID
legal_entity_idstringLegal entity ID
countrystringCountry
start_datestringStart date
end_datestringEnd date
numbernumberWorker number
work_emailstringWork email
personal_emailstringPersonal email
statusstringStatus
employment_type_idstringEmployment type ID
department_idstringDepartment ID
teams_idjsonTeam IDs
titlestringJob title
level_idstringLevel ID
compensation_idstringCompensation ID
overtime_exemptionstringOvertime exemption
title_effective_datestringTitle effective date
business_partners_idjsonBusiness partner IDs
locationjsonWorker location
genderstringGender
date_of_birthstringDate of birth
racestringRace
ethnicitystringEthnicity
citizenshipstringCitizenship
termination_detailsjsonTermination details
custom_fieldsjsonCustom fields
country_fieldsjsonCountry-specific fields
__metajsonMetadata including redacted_fields

rippling_list_users

List all users with optional pagination

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
usersarrayList of users
idstringUser ID
created_atstringRecord creation date
updated_atstringRecord update date
activebooleanWhether the user is active
usernamestringUnique username
display_namestringDisplay name
preferred_languagestringPreferred language
localestringLocale
timezonestringTimezone (IANA format)
numberstringPermanent profile number
namejsonUser name object (given_name, family_name, etc.)
emailsjsonArray of email objects
phone_numbersjsonArray of phone number objects
addressesjsonArray of address objects
photosjsonArray of photo objects
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_user

Get a specific user by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringUser ID
created_atstringCreation date
updated_atstringUpdate date
activebooleanIs active
usernamestringUsername
display_namestringDisplay name
preferred_languagestringPreferred language
localestringLocale
timezonestringTimezone
numberstringProfile number
namejsonUser name object
emailsjsonEmail addresses
phone_numbersjsonPhone numbers
addressesjsonAddresses
photosjsonPhotos
__metajsonMetadata including redacted_fields

rippling_list_companies

List all companies

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
expandstringNeinComma-separated fields to expand
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
companiesarrayList of companies
idstringCompany ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringCompany name
legal_namestringLegal name
doing_business_as_namestringDBA name
phonestringPhone number
primary_emailstringPrimary email
parent_legal_entity_idstringParent legal entity ID
legal_entities_idjsonArray of legal entity IDs
physical_addressjsonPhysical address of the holding entity
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_current_user

Get SSO information for the current user

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
expandstringNeinComma-separated fields to expand

Ausgabe

ParameterTypBeschreibung
idstringUser ID
created_atstringCreation date
updated_atstringUpdate date
work_emailstringWork email
company_idstringCompany ID
companyjsonExpanded company object

rippling_list_entitlements

List all entitlements

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key

Ausgabe

ParameterTypBeschreibung
entitlementsarrayList of entitlements
idstringEntitlement ID
descriptionstringEntitlement description
display_namestringDisplay name
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_list_departments

List all departments

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
expandstringNeinComma-separated fields to expand
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
departmentsarrayList of departments
idstringDepartment ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringDepartment name
parent_idstringParent department ID
reference_codestringReference code
department_hierarchy_idjsonArray of department IDs in hierarchy
parentjsonExpanded parent department
department_hierarchyjsonExpanded department hierarchy
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_department

Get a specific department by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
expandstringNeinComma-separated fields to expand

Ausgabe

ParameterTypBeschreibung
idstringDepartment ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringDepartment name
parent_idstringParent department ID
reference_codestringReference code
department_hierarchy_idjsonArray of department IDs in hierarchy
parentjsonExpanded parent department
department_hierarchyjsonExpanded department hierarchy
__metajsonMetadata including redacted_fields

rippling_create_department

Create a new department

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
namestringJaDepartment name
parentIdstringNeinParent department ID
referenceCodestringNeinReference code

Ausgabe

ParameterTypBeschreibung
idstringDepartment ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
parent_idstringParent department ID
reference_codestringReference code
department_hierarchy_idjsonDepartment hierarchy IDs
parentjsonExpanded parent department
department_hierarchyjsonExpanded department hierarchy

rippling_update_department

Update an existing department

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
namestringNeinDepartment name
parentIdstringNeinParent department ID
referenceCodestringNeinReference code

Ausgabe

ParameterTypBeschreibung
idstringDepartment ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
parent_idstringParent department ID
reference_codestringReference code
department_hierarchy_idjsonDepartment hierarchy IDs
parentjsonExpanded parent department
department_hierarchyjsonExpanded department hierarchy

rippling_list_teams

List all teams

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
expandstringNeinComma-separated fields to expand
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
teamsarrayList of teams
idstringTeam ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringTeam name
parent_idstringParent team ID
parentjsonExpanded parent team
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_team

Get a specific team by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
expandstringNeinComma-separated fields to expand

Ausgabe

ParameterTypBeschreibung
idstringTeam ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
parent_idstringParent team ID
parentjsonExpanded parent team
__metajsonMetadata including redacted_fields

rippling_list_employment_types

List all employment types

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
employmentTypesarrayList of employmentTypes
idstringEmployment type ID
created_atstringRecord creation date
updated_atstringRecord update date
labelstringEmployment type label
namestringEmployment type name
typestringType (CONTRACTOR, EMPLOYEE)
compensation_time_periodstringCompensation period (HOURLY, SALARIED)
amount_workedstringAmount worked (PART-TIME, FULL-TIME, TEMPORARY)
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_employment_type

Get a specific employment type by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringEmployment type ID
created_atstringCreation date
updated_atstringUpdate date
labelstringLabel
namestringName
typestringType (CONTRACTOR, EMPLOYEE)
compensation_time_periodstringCompensation period (HOURLY, SALARIED)
amount_workedstringAmount worked (PART-TIME, FULL-TIME, TEMPORARY)
__metajsonMetadata including redacted_fields

rippling_list_titles

List all titles

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
titlesarrayList of titles
idstringTitle ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringTitle name
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_title

Get a specific title by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringTitle ID
created_atstringCreation date
updated_atstringUpdate date
namestringTitle name
__metajsonMetadata including redacted_fields

rippling_create_title

Create a new title

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
namestringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringTitle ID
created_atstringCreation date
updated_atstringUpdate date
namestringTitle name

rippling_update_title

Update an existing title

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
namestringNeinNo description

Ausgabe

ParameterTypBeschreibung
idstringTitle ID
created_atstringCreation date
updated_atstringUpdate date
namestringTitle name

rippling_delete_title

Delete a title

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaID of the resource to delete

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the resource was deleted

rippling_list_custom_fields

List all custom fields

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
customFieldsarrayList of customFields
idstringCustom field ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringField name
descriptionstringField description
requiredbooleanWhether the field is required
typestringField type (TEXT, DATE, NUMBER, CURRENCY, etc.)
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_list_job_functions

List all job functions

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
jobFunctionsarrayList of jobFunctions
idstringJob function ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringJob function name
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_job_function

Get a specific job function by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringJob function ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
__metajsonMetadata including redacted_fields

rippling_list_work_locations

List all work locations

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
workLocationsarrayList of workLocations
idstringWork location ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringLocation name
addressjsonAddress object
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_work_location

Get a specific work location by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringLocation ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
addressjsonAddress object
__metajsonMetadata including redacted_fields

rippling_create_work_location

Create a new work location

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
namestringJaLocation name
streetAddressstringJaStreet address
localitystringNeinNo description
regionstringNeinState/region
postalCodestringNeinPostal code
countrystringNeinCountry code
addressTypestringNeinAddress type (HOME, WORK, OTHER)

Ausgabe

ParameterTypBeschreibung
idstringLocation ID
created_atstringCreated timestamp
updated_atstringUpdated timestamp
namestringName
addressjsonAddress

rippling_update_work_location

Update a work location

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
namestringNeinLocation name
streetAddressstringNeinStreet address
localitystringNeinNo description
regionstringNeinState/region
postalCodestringNeinPostal code
countrystringNeinCountry code
addressTypestringNeinAddress type (HOME, WORK, OTHER)

Ausgabe

ParameterTypBeschreibung
idstringLocation ID
created_atstringCreated timestamp
updated_atstringUpdated timestamp
namestringName
addressjsonAddress

rippling_delete_work_location

Delete a work location

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaID of the resource to delete

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the resource was deleted

rippling_list_business_partners

List all business partners

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
filterstringNeinFilter expression
expandstringNeinComma-separated fields to expand
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
businessPartnersarrayList of businessPartners
idstringBusiness partner ID
created_atstringRecord creation date
updated_atstringRecord update date
business_partner_group_idstringBusiness partner group ID
worker_idstringWorker ID
client_group_idstringClient group ID
client_group_member_countnumberClient group member count
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_business_partner

Get a specific business partner by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
expandstringNeinComma-separated fields to expand

Ausgabe

ParameterTypBeschreibung
idstringID
created_atstringCreation date
updated_atstringUpdate date
business_partner_group_idstringGroup ID
worker_idstringWorker ID
client_group_idstringClient group ID
client_group_member_countnumberClient group member count
__metajsonMetadata including redacted_fields

rippling_create_business_partner

Create a new business partner

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
businessPartnerGroupIdstringJaBusiness partner group ID
workerIdstringJaWorker ID

Ausgabe

ParameterTypBeschreibung
idstringID
created_atstringCreation date
updated_atstringUpdate date
business_partner_group_idstringGroup ID
worker_idstringWorker ID
client_group_idstringClient group ID
client_group_member_countnumberClient group member count

rippling_delete_business_partner

Delete a business partner

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaID of the resource to delete

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the resource was deleted

rippling_list_business_partner_groups

List all business partner groups

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
expandstringNeinComma-separated fields to expand
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
businessPartnerGroupsarrayList of businessPartnerGroups
idstringBusiness partner group ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringGroup name
domainstringDomain (HR, IT, FINANCE, RECRUITING, OTHER)
default_business_partner_idstringDefault business partner ID
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_business_partner_group

Get a specific business partner group by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
expandstringNeinComma-separated fields to expand

Ausgabe

ParameterTypBeschreibung
idstringID
created_atstringCreation date
updated_atstringUpdate date
namestringName
domainstringDomain
default_business_partner_idstringDefault partner ID
__metajsonMetadata including redacted_fields

rippling_create_business_partner_group

Create a new business partner group

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
namestringJaGroup name
domainstringNeinDomain (HR, IT, FINANCE, RECRUITING, OTHER)
defaultBusinessPartnerIdstringNeinDefault business partner ID

Ausgabe

ParameterTypBeschreibung
idstringID
created_atstringCreation date
updated_atstringUpdate date
namestringName
domainstringDomain
default_business_partner_idstringDefault partner ID

rippling_delete_business_partner_group

Delete a business partner group

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaID of the resource to delete

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the resource was deleted

rippling_list_supergroups

List all supergroups

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
filterstringNeinFilter expression (filterable fields: app_owner_id, group_type)
orderBystringNeinSort field. Prefix with - for descending

Ausgabe

ParameterTypBeschreibung
supergroupsarrayList of supergroups
idstringSupergroup ID
created_atstringRecord creation date
updated_atstringRecord update date
display_namestringDisplay name
descriptionstringDescription
app_owner_idstringApp owner ID
group_typestringGroup type
namestringName
sub_group_typestringSub group type
read_onlybooleanWhether the group is read only
parentstringParent group ID
mutually_exclusive_keystringMutually exclusive key
cumulatively_exhaustive_defaultbooleanWhether the group is the cumulatively exhaustive default
include_terminatedbooleanWhether the group includes terminated roles
allow_non_employeesbooleanWhether the group allows non-employees
can_override_role_statesbooleanWhether the group can override role states
prioritynumberGroup priority
is_invisiblebooleanWhether the group is invisible
ignore_prov_group_matchingbooleanWhether to ignore provisioning group matching
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_supergroup

Get a specific supergroup by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringSupergroup ID
created_atstringRecord creation date
updated_atstringRecord update date
display_namestringDisplay name
descriptionstringDescription
app_owner_idstringApp owner ID
group_typestringGroup type
namestringName
sub_group_typestringSub group type
read_onlybooleanWhether the group is read only
parentstringParent group ID
mutually_exclusive_keystringMutually exclusive key
cumulatively_exhaustive_defaultbooleanWhether the group is the cumulatively exhaustive default
include_terminatedbooleanWhether the group includes terminated roles
allow_non_employeesbooleanWhether the group allows non-employees
can_override_role_statesbooleanWhether the group can override role states
prioritynumberGroup priority
is_invisiblebooleanWhether the group is invisible
ignore_prov_group_matchingbooleanWhether to ignore provisioning group matching
__metajsonMetadata including redacted_fields

rippling_list_supergroup_members

List members of a supergroup

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
groupIdstringJaSupergroup ID
expandstringNeinFields to expand (e.g., worker)
orderBystringNeinSort field

Ausgabe

ParameterTypBeschreibung
membersarrayList of members
idstringMember ID
created_atstringRecord creation date
updated_atstringRecord update date
full_namestringFull name
work_emailstringWork email
worker_idstringWorker ID
workerjsonExpanded worker object
totalCountnumberNumber of members returned
nextLinkstringNext page link
__metajsonMetadata including redacted_fields

rippling_list_supergroup_inclusion_members

List inclusion members of a supergroup

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
groupIdstringJaSupergroup ID
expandstringNeinFields to expand (e.g., worker)
orderBystringNeinSort field

Ausgabe

ParameterTypBeschreibung
membersarrayList of members
idstringMember ID
created_atstringRecord creation date
updated_atstringRecord update date
full_namestringFull name
work_emailstringWork email
worker_idstringWorker ID
workerjsonExpanded worker object
totalCountnumberNumber of members returned
nextLinkstringNext page link
__metajsonMetadata including redacted_fields

rippling_list_supergroup_exclusion_members

List exclusion members of a supergroup

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
groupIdstringJaSupergroup ID
expandstringNeinFields to expand (e.g., worker)
orderBystringNeinSort field

Ausgabe

ParameterTypBeschreibung
membersarrayList of members
idstringMember ID
created_atstringRecord creation date
updated_atstringRecord update date
full_namestringFull name
work_emailstringWork email
worker_idstringWorker ID
workerjsonExpanded worker object
totalCountnumberNumber of members returned
nextLinkstringNext page link
__metajsonMetadata including redacted_fields

rippling_update_supergroup_inclusion_members

Update inclusion members of a supergroup

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
groupIdstringJaSupergroup ID
operationsjsonJaOperations array [{op: "add"|"remove", value: [{id: "member_id"}]}]

Ausgabe

ParameterTypBeschreibung
okbooleanWhether the operation succeeded

rippling_update_supergroup_exclusion_members

Update exclusion members of a supergroup

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
groupIdstringJaSupergroup ID
operationsjsonJaOperations array [{op: "add"|"remove", value: [{id: "member_id"}]}]

Ausgabe

ParameterTypBeschreibung
okbooleanWhether the operation succeeded

rippling_list_custom_objects

List all custom objects

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key

Ausgabe

ParameterTypBeschreibung
customObjectsarrayList of customObjects
idstringCustom object ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringObject name
descriptionstringDescription
api_namestringAPI name
plural_labelstringPlural label
category_idstringCategory ID
native_category_idstringNative category ID
managed_package_install_idstringPackage install ID
owner_idstringOwner ID
enable_historybooleanWhether history is enabled
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results

rippling_get_custom_object

Get a custom object by API name

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJacustom object api name

Ausgabe

ParameterTypBeschreibung
idstringID
created_atstringCreation date
updated_atstringUpdate date
namestringName
descriptionstringDescription
api_namestringAPI name
plural_labelstringPlural label
category_idstringCategory ID
enable_historybooleanHistory enabled
native_category_idstringNative category ID
managed_package_install_idstringPackage install ID
owner_idstringOwner ID

rippling_create_custom_object

Create a new custom object

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
namestringJaNo description
descriptionstringNeinDescription
categorystringNeinCategory

Ausgabe

ParameterTypBeschreibung
idstringID
created_atstringCreation date
updated_atstringUpdate date
namestringName
descriptionstringDescription
api_namestringAPI name
plural_labelstringPlural label
category_idstringCategory ID
enable_historybooleanHistory enabled
native_category_idstringNative category ID
managed_package_install_idstringPackage install ID
owner_idstringOwner ID

rippling_update_custom_object

Update a custom object

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
namestringNeinNo description
descriptionstringNeinDescription
categorystringNeinCategory
pluralLabelstringNeinPlural label
ownerRolestringNeinOwner role

Ausgabe

ParameterTypBeschreibung
idstringID
created_atstringCreation date
updated_atstringUpdate date
namestringName
descriptionstringDescription
api_namestringAPI name
plural_labelstringPlural label
category_idstringCategory ID
enable_historybooleanHistory enabled
native_category_idstringNative category ID
managed_package_install_idstringPackage install ID
owner_idstringOwner ID

rippling_delete_custom_object

Delete a custom object

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaID of the resource to delete

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the resource was deleted

rippling_list_custom_object_fields

List all fields for a custom object

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name

Ausgabe

ParameterTypBeschreibung
fieldsarrayList of fields
idstringField ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringField name
custom_objectstringParent custom object
descriptionstringDescription
api_namestringAPI name
data_typejsonData type configuration
is_uniquebooleanWhether the field is unique
is_immutablebooleanWhether the field is immutable
is_standardbooleanWhether the field is standard
enable_historybooleanWhether history is enabled
managed_package_install_idstringPackage install ID
totalCountnumberNumber of fields returned
nextLinkstringNext page link

rippling_get_custom_object_field

Get a specific field of a custom object

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
fieldApiNamestringJaField API name

Ausgabe

ParameterTypBeschreibung
idstringField ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
custom_objectstringCustom object
descriptionstringDescription
api_namestringAPI name
data_typejsonData type configuration
is_uniquebooleanIs unique
is_immutablebooleanIs immutable
is_standardbooleanIs standard
enable_historybooleanHistory enabled
managed_package_install_idstringPackage install ID

rippling_create_custom_object_field

Create a field on a custom object

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
namestringJaField name
descriptionstringNeinDescription
dataTypejsonJaData type configuration
requiredbooleanNeinWhether the field is required
rqlDefinitionjsonNeinRQL definition object
isUniquebooleanNeinWhether field is unique
formulaAttrMetasjsonNeinFormula attribute metadata
sectionjsonNeinSection configuration
enableHistorybooleanNeinEnable history tracking
derivedFieldFormulastringNeinDerived field formula expression
derivedAggregatedFieldjsonNeinDerived aggregated field configuration

Ausgabe

ParameterTypBeschreibung
idstringField ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
custom_objectstringCustom object
descriptionstringDescription
api_namestringAPI name
data_typejsonData type configuration
is_uniquebooleanIs unique
is_immutablebooleanIs immutable
is_standardbooleanIs standard
enable_historybooleanHistory enabled
managed_package_install_idstringPackage install ID

rippling_update_custom_object_field

Update a field on a custom object

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
fieldApiNamestringJaField API name
namestringNeinField name
descriptionstringNeinDescription
dataTypejsonNeinData type
requiredbooleanNeinWhether the field is required
rqlDefinitionjsonNeinRQL definition object
isUniquebooleanNeinIs unique
formulaAttrMetasjsonNeinFormula attribute metadata
sectionjsonNeinSection configuration
enableHistorybooleanNeinEnable history
derivedFieldFormulastringNeinDerived field formula expression
nameFieldDetailsjsonNeinName field details configuration

Ausgabe

ParameterTypBeschreibung
idstringField ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
custom_objectstringCustom object
descriptionstringDescription
api_namestringAPI name
data_typejsonData type configuration
is_uniquebooleanIs unique
is_immutablebooleanIs immutable
is_standardbooleanIs standard
enable_historybooleanHistory enabled
managed_package_install_idstringPackage install ID

rippling_delete_custom_object_field

Delete a field from a custom object

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
fieldApiNamestringJaField API name

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the field was deleted

rippling_list_custom_object_records

List all records for a custom object

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name

Ausgabe

ParameterTypBeschreibung
recordsarrayList of records
idstringRecord ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringRecord name
external_idstringExternal ID
created_byjsonCreated by user (id, display_value, image)
last_modified_byjsonLast modified by user (id, display_value, image)
owner_rolejsonOwner role (id, display_value, image)
system_updated_atstringSystem update timestamp
datajsonFull record data including dynamic fields
totalCountnumberNumber of records returned
nextLinkstringNext page link

rippling_get_custom_object_record

Get a specific custom object record

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
codrIdstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringRecord ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringRecord name
external_idstringExternal ID
created_byjsonCreated by user (id, display_value, image)
last_modified_byjsonLast modified by user (id, display_value, image)
owner_rolejsonOwner role (id, display_value, image)
system_updated_atstringSystem update timestamp
datajsonFull record data

rippling_get_custom_object_record_by_external_id

Get a custom object record by external ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
externalIdstringJaExternal ID

Ausgabe

ParameterTypBeschreibung
idstringRecord ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringRecord name
external_idstringExternal ID
created_byjsonCreated by user (id, display_value, image)
last_modified_byjsonLast modified by user (id, display_value, image)
owner_rolejsonOwner role (id, display_value, image)
system_updated_atstringSystem update timestamp
datajsonFull record data

rippling_query_custom_object_records

Query custom object records with filters

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
querystringNeinQuery expression
limitnumberNeinMaximum number of records to return
cursorstringNeinPagination cursor

Ausgabe

ParameterTypBeschreibung
recordsarrayMatching records
idstringRecord ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringRecord name
external_idstringExternal ID
created_byjsonCreated by user (id, display_value, image)
last_modified_byjsonLast modified by user (id, display_value, image)
owner_rolejsonOwner role (id, display_value, image)
system_updated_atstringSystem update timestamp
datajsonFull record data
totalCountnumberNumber of records returned
cursorstringCursor for next page of results

rippling_create_custom_object_record

Create a custom object record

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
externalIdstringNeinExternal ID for the record
datajsonJaNo description

Ausgabe

ParameterTypBeschreibung
idstringRecord ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringRecord name
external_idstringExternal ID
created_byjsonCreated by user (id, display_value, image)
last_modified_byjsonLast modified by user (id, display_value, image)
owner_rolejsonOwner role (id, display_value, image)
system_updated_atstringSystem update timestamp
datajsonFull record data

rippling_update_custom_object_record

Update a custom object record

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
codrIdstringJaRecord ID
externalIdstringNeinExternal ID for the record
datajsonNeinUpdated record data

Ausgabe

ParameterTypBeschreibung
idstringRecord ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringRecord name
external_idstringExternal ID
created_byjsonCreated by user (id, display_value, image)
last_modified_byjsonLast modified by user (id, display_value, image)
owner_rolejsonOwner role (id, display_value, image)
system_updated_atstringSystem update timestamp
datajsonFull record data

rippling_delete_custom_object_record

Delete a custom object record

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
codrIdstringJaRecord ID

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the record was deleted

rippling_bulk_create_custom_object_records

Bulk create custom object records

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
rowsToWritejsonJaArray of records to create [{external_id?, data}]
allOrNothingbooleanNeinIf true, fail entire batch on any error

Ausgabe

ParameterTypBeschreibung
createdRecordsarrayCreated custom object records
totalCountnumberNumber of records created

rippling_bulk_update_custom_object_records

Bulk update custom object records

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
rowsToUpdatejsonJaArray of records to update
allOrNothingbooleanNeinIf true, fail entire batch on any error

Ausgabe

ParameterTypBeschreibung
updatedRecordsarrayUpdated custom object records
totalCountnumberNumber of records updated

rippling_bulk_delete_custom_object_records

Bulk delete custom object records

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
customObjectApiNamestringJaCustom object API name
rowsToDeletejsonJaArray of records to delete
allOrNothingbooleanNeinIf true, fail entire batch on any error

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the bulk delete succeeded

rippling_list_custom_apps

List all custom apps

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key

Ausgabe

ParameterTypBeschreibung
customAppsarrayList of customApps
idstringApp ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringApp name
api_namestringAPI name
descriptionstringDescription
iconstringIcon URL
pagesjsonArray of page summaries
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_custom_app

Get a specific custom app

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringApp ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
api_namestringAPI name
descriptionstringDescription
iconstringIcon URL
pagesjsonArray of page summaries
__metajsonMetadata including redacted_fields

rippling_create_custom_app

Create a new custom app

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
namestringJaNo description
apiNamestringJaNo description
descriptionstringNeinDescription

Ausgabe

ParameterTypBeschreibung
idstringApp ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
api_namestringAPI name
descriptionstringDescription
iconstringIcon URL
pagesjsonArray of page summaries

rippling_update_custom_app

Update a custom app

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
namestringNeinNo description
apiNamestringNeinAPI name
descriptionstringNeinDescription

Ausgabe

ParameterTypBeschreibung
idstringApp ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
api_namestringAPI name
descriptionstringDescription
iconstringIcon URL
pagesjsonArray of page summaries

rippling_delete_custom_app

Delete a custom app

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaID of the resource to delete

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the resource was deleted

rippling_list_custom_pages

List all custom pages

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key

Ausgabe

ParameterTypBeschreibung
customPagesarrayList of customPages
idstringPage ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringPage name
componentsjsonPage components
actionsjsonPage actions
canvas_actionsjsonCanvas actions
variablesjsonPage variables
mediajsonPage media
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_custom_page

Get a specific custom page

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringPage ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
componentsjsonPage components
actionsjsonPage actions
canvas_actionsjsonCanvas actions
variablesjsonPage variables
mediajsonPage media
__metajsonMetadata including redacted_fields

rippling_create_custom_page

Create a new custom page

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
namestringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringPage ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
componentsjsonPage components
actionsjsonPage actions
canvas_actionsjsonCanvas actions
variablesjsonPage variables
mediajsonPage media

rippling_update_custom_page

Update a custom page

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
namestringNeinNo description

Ausgabe

ParameterTypBeschreibung
idstringPage ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
componentsjsonPage components
actionsjsonPage actions
canvas_actionsjsonCanvas actions
variablesjsonPage variables
mediajsonPage media

rippling_delete_custom_page

Delete a custom page

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaID of the resource to delete

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the resource was deleted

rippling_list_custom_settings

List all custom settings

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
orderBystringNeinSort field. Prefix with - for descending
cursorstringNeinPagination cursor from previous response

Ausgabe

ParameterTypBeschreibung
customSettingsarrayList of custom settings
idstringSetting ID
created_atstringRecord creation date
updated_atstringRecord update date
display_namestringDisplay name
api_namestringAPI name
data_typestringData type
secret_valuestringSecret value
string_valuestringString value
number_valuenumberNumber value
boolean_valuebooleanBoolean value
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results
__metajsonMetadata including redacted_fields

rippling_get_custom_setting

Get a specific custom setting

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringSetting ID
created_atstringRecord creation date
updated_atstringRecord update date
display_namestringDisplay name
api_namestringAPI name
data_typestringData type
secret_valuestringSecret value
string_valuestringString value
number_valuenumberNumber value
boolean_valuebooleanBoolean value
__metajsonMetadata including redacted_fields

rippling_create_custom_setting

Create a new custom setting

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
displayNamestringNeinDisplay name
apiNamestringNeinUnique API name
dataTypestringNeinData type of the setting
secretValuestringNeinSecret value (for secret data type)
stringValuestringNeinString value (for string data type)
numberValuenumberNeinNumber value (for number data type)
booleanValuebooleanNeinBoolean value (for boolean data type)

Ausgabe

ParameterTypBeschreibung
idstringSetting ID
created_atstringRecord creation date
updated_atstringRecord update date
display_namestringDisplay name
api_namestringAPI name
data_typestringData type
secret_valuestringSecret value
string_valuestringString value
number_valuenumberNumber value
boolean_valuebooleanBoolean value

rippling_update_custom_setting

Update a custom setting

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
displayNamestringNeinDisplay name
apiNamestringNeinUnique API name
dataTypestringNeinData type of the setting
secretValuestringNeinSecret value (for secret data type)
stringValuestringNeinString value (for string data type)
numberValuenumberNeinNumber value (for number data type)
booleanValuebooleanNeinBoolean value (for boolean data type)

Ausgabe

ParameterTypBeschreibung
idstringSetting ID
created_atstringRecord creation date
updated_atstringRecord update date
display_namestringDisplay name
api_namestringAPI name
data_typestringData type
secret_valuestringSecret value
string_valuestringString value
number_valuenumberNumber value
boolean_valuebooleanBoolean value

rippling_delete_custom_setting

Delete a custom setting

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaID of the resource to delete

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the resource was deleted

rippling_list_object_categories

List all object categories

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key

Ausgabe

ParameterTypBeschreibung
objectCategoriesarrayList of objectCategories
idstringCategory ID
created_atstringRecord creation date
updated_atstringRecord update date
namestringCategory name
descriptionstringDescription
totalCountnumberNumber of items returned
nextLinkstringLink to next page of results

rippling_get_object_category

Get a specific object category

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringCategory ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
descriptionstringDescription

rippling_create_object_category

Create a new object category

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
namestringJaCategory name
descriptionstringNeinDescription

Ausgabe

ParameterTypBeschreibung
idstringCategory ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
descriptionstringDescription

rippling_update_object_category

Update an object category

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaNo description
namestringNeinCategory name
descriptionstringNeinDescription

Ausgabe

ParameterTypBeschreibung
idstringCategory ID
created_atstringCreation date
updated_atstringUpdate date
namestringName
descriptionstringDescription

rippling_delete_object_category

Delete an object category

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
idstringJaID of the resource to delete

Ausgabe

ParameterTypBeschreibung
deletedbooleanWhether the resource was deleted

rippling_get_report_run

Get a report run by ID

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
runIdstringJaNo description

Ausgabe

ParameterTypBeschreibung
idstringReport run ID
report_idstringReport ID
statusstringRun status
file_urlstringURL to download the report file
expires_atstringExpiration timestamp for the file URL
output_typestringOutput format (JSON or CSV)
__metajsonMetadata including redacted_fields

rippling_trigger_report_run

Trigger a new report run

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
reportIdstringJaReport ID to run
includeObjectIdsbooleanNeinInclude object IDs in the report
includeTotalRowsbooleanNeinInclude total row count
formatDateFieldsjsonNeinDate field formatting configuration
formatCurrencyFieldsjsonNeinCurrency field formatting configuration
outputTypestringNeinOutput type (JSON or CSV)

Ausgabe

ParameterTypBeschreibung
idstringReport run ID
report_idstringReport ID
statusstringRun status
file_urlstringURL to download the report file
expires_atstringExpiration timestamp for the file URL
output_typestringOutput format (JSON or CSV)

rippling_create_draft_hires

Create bulk draft hires

Eingabe

ParameterTypErforderlichBeschreibung
apiKeystringJaRippling API key
draftHiresjsonJaArray of draft hire objects

Ausgabe

ParameterTypBeschreibung
invalidItemsjsonFailed draft hires
successfulResultsjsonSuccessful draft hires
totalInvalidnumberNumber of failures
totalSuccessfulnumberNumber of successes

On this page

Nutzungsanleitung
Tools
rippling_list_workers
Eingabe
Ausgabe
rippling_get_worker
Eingabe
Ausgabe
rippling_list_users
Eingabe
Ausgabe
rippling_get_user
Eingabe
Ausgabe
rippling_list_companies
Eingabe
Ausgabe
rippling_get_current_user
Eingabe
Ausgabe
rippling_list_entitlements
Eingabe
Ausgabe
rippling_list_departments
Eingabe
Ausgabe
rippling_get_department
Eingabe
Ausgabe
rippling_create_department
Eingabe
Ausgabe
rippling_update_department
Eingabe
Ausgabe
rippling_list_teams
Eingabe
Ausgabe
rippling_get_team
Eingabe
Ausgabe
rippling_list_employment_types
Eingabe
Ausgabe
rippling_get_employment_type
Eingabe
Ausgabe
rippling_list_titles
Eingabe
Ausgabe
rippling_get_title
Eingabe
Ausgabe
rippling_create_title
Eingabe
Ausgabe
rippling_update_title
Eingabe
Ausgabe
rippling_delete_title
Eingabe
Ausgabe
rippling_list_custom_fields
Eingabe
Ausgabe
rippling_list_job_functions
Eingabe
Ausgabe
rippling_get_job_function
Eingabe
Ausgabe
rippling_list_work_locations
Eingabe
Ausgabe
rippling_get_work_location
Eingabe
Ausgabe
rippling_create_work_location
Eingabe
Ausgabe
rippling_update_work_location
Eingabe
Ausgabe
rippling_delete_work_location
Eingabe
Ausgabe
rippling_list_business_partners
Eingabe
Ausgabe
rippling_get_business_partner
Eingabe
Ausgabe
rippling_create_business_partner
Eingabe
Ausgabe
rippling_delete_business_partner
Eingabe
Ausgabe
rippling_list_business_partner_groups
Eingabe
Ausgabe
rippling_get_business_partner_group
Eingabe
Ausgabe
rippling_create_business_partner_group
Eingabe
Ausgabe
rippling_delete_business_partner_group
Eingabe
Ausgabe
rippling_list_supergroups
Eingabe
Ausgabe
rippling_get_supergroup
Eingabe
Ausgabe
rippling_list_supergroup_members
Eingabe
Ausgabe
rippling_list_supergroup_inclusion_members
Eingabe
Ausgabe
rippling_list_supergroup_exclusion_members
Eingabe
Ausgabe
rippling_update_supergroup_inclusion_members
Eingabe
Ausgabe
rippling_update_supergroup_exclusion_members
Eingabe
Ausgabe
rippling_list_custom_objects
Eingabe
Ausgabe
rippling_get_custom_object
Eingabe
Ausgabe
rippling_create_custom_object
Eingabe
Ausgabe
rippling_update_custom_object
Eingabe
Ausgabe
rippling_delete_custom_object
Eingabe
Ausgabe
rippling_list_custom_object_fields
Eingabe
Ausgabe
rippling_get_custom_object_field
Eingabe
Ausgabe
rippling_create_custom_object_field
Eingabe
Ausgabe
rippling_update_custom_object_field
Eingabe
Ausgabe
rippling_delete_custom_object_field
Eingabe
Ausgabe
rippling_list_custom_object_records
Eingabe
Ausgabe
rippling_get_custom_object_record
Eingabe
Ausgabe
rippling_get_custom_object_record_by_external_id
Eingabe
Ausgabe
rippling_query_custom_object_records
Eingabe
Ausgabe
rippling_create_custom_object_record
Eingabe
Ausgabe
rippling_update_custom_object_record
Eingabe
Ausgabe
rippling_delete_custom_object_record
Eingabe
Ausgabe
rippling_bulk_create_custom_object_records
Eingabe
Ausgabe
rippling_bulk_update_custom_object_records
Eingabe
Ausgabe
rippling_bulk_delete_custom_object_records
Eingabe
Ausgabe
rippling_list_custom_apps
Eingabe
Ausgabe
rippling_get_custom_app
Eingabe
Ausgabe
rippling_create_custom_app
Eingabe
Ausgabe
rippling_update_custom_app
Eingabe
Ausgabe
rippling_delete_custom_app
Eingabe
Ausgabe
rippling_list_custom_pages
Eingabe
Ausgabe
rippling_get_custom_page
Eingabe
Ausgabe
rippling_create_custom_page
Eingabe
Ausgabe
rippling_update_custom_page
Eingabe
Ausgabe
rippling_delete_custom_page
Eingabe
Ausgabe
rippling_list_custom_settings
Eingabe
Ausgabe
rippling_get_custom_setting
Eingabe
Ausgabe
rippling_create_custom_setting
Eingabe
Ausgabe
rippling_update_custom_setting
Eingabe
Ausgabe
rippling_delete_custom_setting
Eingabe
Ausgabe
rippling_list_object_categories
Eingabe
Ausgabe
rippling_get_object_category
Eingabe
Ausgabe
rippling_create_object_category
Eingabe
Ausgabe
rippling_update_object_category
Eingabe
Ausgabe
rippling_delete_object_category
Eingabe
Ausgabe
rippling_get_report_run
Eingabe
Ausgabe
rippling_trigger_report_run
Eingabe
Ausgabe
rippling_create_draft_hires
Eingabe
Ausgabe
Heute mit dem Aufbau beginnen
Über 100 000 Entwickler vertrauen uns.
Die SaaS-Plattform zum Aufbau von KI-Agenten und für Ihre agentische Belegschaft.
Loslegen