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.
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.
List all workers with optional filtering and pagination
Parameter Type Required Description apiKeystring Yes Rippling API key filterstring No Filter expression expandstring No Comma-separated fields to expand orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description workersarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific worker by ID
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID expandstring No Comma-separated fields to expand
Parameter Type Description idstring Worker ID created_atstring Creation date updated_atstring Update date user_idstring User ID is_managerboolean Is manager manager_idstring Manager ID legal_entity_idstring Legal entity ID countrystring Country start_datestring Start date end_datestring End date numbernumber Worker number work_emailstring Work email personal_emailstring Personal email statusstring Status employment_type_idstring Employment type ID department_idstring Department ID teams_idjson Team IDs titlestring Job title level_idstring Level ID compensation_idstring Compensation ID overtime_exemptionstring Overtime exemption title_effective_datestring Title effective date business_partners_idjson Business partner IDs locationjson Worker location genderstring Gender date_of_birthstring Date of birth racestring Race ethnicitystring Ethnicity citizenshipstring Citizenship termination_detailsjson Termination details custom_fieldsjson Custom fields country_fieldsjson Country-specific fields __metajson Metadata including redacted_fields
List all users with optional pagination
Parameter Type Required Description apiKeystring Yes Rippling API key orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description usersarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific user by ID
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID
Parameter Type Description idstring User ID created_atstring Creation date updated_atstring Update date activeboolean Is active usernamestring Username display_namestring Display name preferred_languagestring Preferred language localestring Locale timezonestring Timezone numberstring Profile number namejson User name object emailsjson Email addresses phone_numbersjson Phone numbers addressesjson Addresses photosjson Photos __metajson Metadata including redacted_fields
List all companies
Parameter Type Required Description apiKeystring Yes Rippling API key expandstring No Comma-separated fields to expand orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description companiesarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get SSO information for the current user
Parameter Type Required Description apiKeystring Yes Rippling API key expandstring No Comma-separated fields to expand
Parameter Type Description idstring User ID created_atstring Creation date updated_atstring Update date work_emailstring Work email company_idstring Company ID companyjson Expanded company object
List all entitlements
Parameter Type Required Description apiKeystring Yes Rippling API key
Parameter Type Description entitlementsarray List of entitlements ↳ id string Entitlement ID ↳ description string Entitlement description ↳ display_name string Display name totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
List all departments
Parameter Type Required Description apiKeystring Yes Rippling API key expandstring No Comma-separated fields to expand orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description departmentsarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific department by ID
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID expandstring No Comma-separated fields to expand
Parameter Type Description idstring Department ID created_atstring Record creation date updated_atstring Record update date namestring Department name parent_idstring Parent department ID reference_codestring Reference code department_hierarchy_idjson Array of department IDs in hierarchy parentjson Expanded parent department department_hierarchyjson Expanded department hierarchy __metajson Metadata including redacted_fields
Create a new department
Parameter Type Required Description apiKeystring Yes Rippling API key namestring Yes Department name parentIdstring No Parent department ID referenceCodestring No Reference code
Parameter Type Description idstring Department ID created_atstring Creation date updated_atstring Update date namestring Name parent_idstring Parent department ID reference_codestring Reference code department_hierarchy_idjson Department hierarchy IDs parentjson Expanded parent department department_hierarchyjson Expanded department hierarchy
Update an existing department
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Department ID namestring No Department name parentIdstring No Parent department ID referenceCodestring No Reference code
Parameter Type Description idstring Department ID created_atstring Creation date updated_atstring Update date namestring Name parent_idstring Parent department ID reference_codestring Reference code department_hierarchy_idjson Department hierarchy IDs parentjson Expanded parent department department_hierarchyjson Expanded department hierarchy
List all teams
Parameter Type Required Description apiKeystring Yes Rippling API key expandstring No Comma-separated fields to expand orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description teamsarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific team by ID
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID expandstring No Comma-separated fields to expand
Parameter Type Description idstring Team ID created_atstring Creation date updated_atstring Update date namestring Name parent_idstring Parent team ID parentjson Expanded parent team __metajson Metadata including redacted_fields
List all employment types
Parameter Type Required Description apiKeystring Yes Rippling API key orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description employmentTypesarray 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) totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific employment type by ID
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID
Parameter Type Description idstring Employment type ID created_atstring Creation date updated_atstring Update date labelstring Label namestring Name typestring Type (CONTRACTOR, EMPLOYEE) compensation_time_periodstring Compensation period (HOURLY, SALARIED) amount_workedstring Amount worked (PART-TIME, FULL-TIME, TEMPORARY) __metajson Metadata including redacted_fields
List all titles
Parameter Type Required Description apiKeystring Yes Rippling API key orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description titlesarray List of titles ↳ id string Title ID ↳ created_at string Record creation date ↳ updated_at string Record update date ↳ name string Title name totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific title by ID
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID
Parameter Type Description idstring Title ID created_atstring Creation date updated_atstring Update date namestring Title name __metajson Metadata including redacted_fields
Create a new title
Parameter Type Required Description apiKeystring Yes Rippling API key namestring Yes Title name
Parameter Type Description idstring Title ID created_atstring Creation date updated_atstring Update date namestring Title name
Update an existing title
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Title ID namestring No Title name
Parameter Type Description idstring Title ID created_atstring Creation date updated_atstring Update date namestring Title name
Delete a title
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes ID of the resource to delete
Parameter Type Description deletedboolean Whether the resource was deleted
List all custom fields
Parameter Type Required Description apiKeystring Yes Rippling API key orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description customFieldsarray 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.) totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
List all job functions
Parameter Type Required Description apiKeystring Yes Rippling API key orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description jobFunctionsarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific job function by ID
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID
Parameter Type Description idstring Job function ID created_atstring Creation date updated_atstring Update date namestring Name __metajson Metadata including redacted_fields
List all work locations
Parameter Type Required Description apiKeystring Yes Rippling API key orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description workLocationsarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific work location by ID
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID
Parameter Type Description idstring Location ID created_atstring Creation date updated_atstring Update date namestring Name addressjson Address object __metajson Metadata including redacted_fields
Create a new work location
Parameter Type Required Description apiKeystring Yes Rippling API key namestring Yes Location name streetAddressstring Yes Street address localitystring No City regionstring No State/region postalCodestring No Postal code countrystring No Country code addressTypestring No Address type (HOME, WORK, OTHER)
Parameter Type Description idstring Location ID created_atstring Created timestamp updated_atstring Updated timestamp namestring Name addressjson Address
Update a work location
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Location ID namestring No Location name streetAddressstring No Street address localitystring No City regionstring No State/region postalCodestring No Postal code countrystring No Country code addressTypestring No Address type (HOME, WORK, OTHER)
Parameter Type Description idstring Location ID created_atstring Created timestamp updated_atstring Updated timestamp namestring Name addressjson Address
Delete a work location
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes ID of the resource to delete
Parameter Type Description deletedboolean Whether the resource was deleted
List all business partners
Parameter Type Required Description apiKeystring Yes Rippling API key filterstring No Filter expression expandstring No Comma-separated fields to expand orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description businessPartnersarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific business partner by ID
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID expandstring No Comma-separated fields to expand
Parameter Type Description idstring ID created_atstring Creation date updated_atstring Update date business_partner_group_idstring Group ID worker_idstring Worker ID client_group_idstring Client group ID client_group_member_countnumber Client group member count __metajson Metadata including redacted_fields
Create a new business partner
Parameter Type Required Description apiKeystring Yes Rippling API key businessPartnerGroupIdstring Yes Business partner group ID workerIdstring Yes Worker ID
Parameter Type Description idstring ID created_atstring Creation date updated_atstring Update date business_partner_group_idstring Group ID worker_idstring Worker ID client_group_idstring Client group ID client_group_member_countnumber Client group member count
Delete a business partner
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes ID of the resource to delete
Parameter Type Description deletedboolean Whether the resource was deleted
List all business partner groups
Parameter Type Required Description apiKeystring Yes Rippling API key expandstring No Comma-separated fields to expand orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description businessPartnerGroupsarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific business partner group by ID
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID expandstring No Comma-separated fields to expand
Parameter Type Description idstring ID created_atstring Creation date updated_atstring Update date namestring Name domainstring Domain default_business_partner_idstring Default partner ID __metajson Metadata including redacted_fields
Create a new business partner group
Parameter Type Required Description apiKeystring Yes Rippling API key namestring Yes Group name domainstring No Domain (HR, IT, FINANCE, RECRUITING, OTHER) defaultBusinessPartnerIdstring No Default business partner ID
Parameter Type Description idstring ID created_atstring Creation date updated_atstring Update date namestring Name domainstring Domain default_business_partner_idstring Default partner ID
Delete a business partner group
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes ID of the resource to delete
Parameter Type Description deletedboolean Whether the resource was deleted
List all supergroups
Parameter Type Required Description apiKeystring Yes Rippling API key filterstring No Filter expression (filterable fields: app_owner_id, group_type) orderBystring No Sort field. Prefix with - for descending
Parameter Type Description supergroupsarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific supergroup by ID
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID
Parameter Type Description idstring Supergroup ID created_atstring Record creation date updated_atstring Record update date display_namestring Display name descriptionstring Description app_owner_idstring App owner ID group_typestring Group type namestring Name sub_group_typestring Sub group type read_onlyboolean Whether the group is read only parentstring Parent group ID mutually_exclusive_keystring Mutually exclusive key cumulatively_exhaustive_defaultboolean Whether the group is the cumulatively exhaustive default include_terminatedboolean Whether the group includes terminated roles allow_non_employeesboolean Whether the group allows non-employees can_override_role_statesboolean Whether the group can override role states prioritynumber Group priority is_invisibleboolean Whether the group is invisible ignore_prov_group_matchingboolean Whether to ignore provisioning group matching __metajson Metadata including redacted_fields
List members of a supergroup
Parameter Type Required Description apiKeystring Yes Rippling API key groupIdstring Yes Supergroup ID expandstring No Fields to expand (e.g., worker) orderBystring No Sort field
Parameter Type Description membersarray 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 totalCountnumber Number of members returned nextLinkstring Next page link __metajson Metadata including redacted_fields
List inclusion members of a supergroup
Parameter Type Required Description apiKeystring Yes Rippling API key groupIdstring Yes Supergroup ID expandstring No Fields to expand (e.g., worker) orderBystring No Sort field
Parameter Type Description membersarray 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 totalCountnumber Number of members returned nextLinkstring Next page link __metajson Metadata including redacted_fields
List exclusion members of a supergroup
Parameter Type Required Description apiKeystring Yes Rippling API key groupIdstring Yes Supergroup ID expandstring No Fields to expand (e.g., worker) orderBystring No Sort field
Parameter Type Description membersarray 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 totalCountnumber Number of members returned nextLinkstring Next page link __metajson Metadata including redacted_fields
Update inclusion members of a supergroup
Parameter Type Required Description apiKeystring Yes Rippling API key groupIdstring Yes Supergroup ID operationsjson Yes Operations array [{op: "add"|"remove", value: [{id: "member_id"}]}]
Parameter Type Description okboolean Whether the operation succeeded
Update exclusion members of a supergroup
Parameter Type Required Description apiKeystring Yes Rippling API key groupIdstring Yes Supergroup ID operationsjson Yes Operations array [{op: "add"|"remove", value: [{id: "member_id"}]}]
Parameter Type Description okboolean Whether the operation succeeded
List all custom objects
Parameter Type Required Description apiKeystring Yes Rippling API key
Parameter Type Description customObjectsarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results
Get a custom object by API name
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes custom object api name
Parameter Type Description idstring ID created_atstring Creation date updated_atstring Update date namestring Name descriptionstring Description api_namestring API name plural_labelstring Plural label category_idstring Category ID enable_historyboolean History enabled native_category_idstring Native category ID managed_package_install_idstring Package install ID owner_idstring Owner ID
Create a new custom object
Parameter Type Required Description apiKeystring Yes Rippling API key namestring Yes Object name descriptionstring No Description categorystring No Category
Parameter Type Description idstring ID created_atstring Creation date updated_atstring Update date namestring Name descriptionstring Description api_namestring API name plural_labelstring Plural label category_idstring Category ID enable_historyboolean History enabled native_category_idstring Native category ID managed_package_install_idstring Package install ID owner_idstring Owner ID
Update a custom object
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name namestring No Name descriptionstring No Description categorystring No Category pluralLabelstring No Plural label ownerRolestring No Owner role
Parameter Type Description idstring ID created_atstring Creation date updated_atstring Update date namestring Name descriptionstring Description api_namestring API name plural_labelstring Plural label category_idstring Category ID enable_historyboolean History enabled native_category_idstring Native category ID managed_package_install_idstring Package install ID owner_idstring Owner ID
Delete a custom object
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes ID of the resource to delete
Parameter Type Description deletedboolean Whether the resource was deleted
List all fields for a custom object
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name
Parameter Type Description fieldsarray 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 totalCountnumber Number of fields returned nextLinkstring Next page link
Get a specific field of a custom object
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name fieldApiNamestring Yes Field API name
Parameter Type Description idstring Field ID created_atstring Creation date updated_atstring Update date namestring Name custom_objectstring Custom object descriptionstring Description api_namestring API name data_typejson Data type configuration is_uniqueboolean Is unique is_immutableboolean Is immutable is_standardboolean Is standard enable_historyboolean History enabled managed_package_install_idstring Package install ID
Create a field on a custom object
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name namestring Yes Field name descriptionstring No Description dataTypejson Yes Data type configuration requiredboolean No Whether the field is required rqlDefinitionjson No RQL definition object isUniqueboolean No Whether field is unique formulaAttrMetasjson No Formula attribute metadata sectionjson No Section configuration enableHistoryboolean No Enable history tracking derivedFieldFormulastring No Derived field formula expression derivedAggregatedFieldjson No Derived aggregated field configuration
Parameter Type Description idstring Field ID created_atstring Creation date updated_atstring Update date namestring Name custom_objectstring Custom object descriptionstring Description api_namestring API name data_typejson Data type configuration is_uniqueboolean Is unique is_immutableboolean Is immutable is_standardboolean Is standard enable_historyboolean History enabled managed_package_install_idstring Package install ID
Update a field on a custom object
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name fieldApiNamestring Yes Field API name namestring No Field name descriptionstring No Description dataTypejson No Data type requiredboolean No Whether the field is required rqlDefinitionjson No RQL definition object isUniqueboolean No Is unique formulaAttrMetasjson No Formula attribute metadata sectionjson No Section configuration enableHistoryboolean No Enable history derivedFieldFormulastring No Derived field formula expression nameFieldDetailsjson No Name field details configuration
Parameter Type Description idstring Field ID created_atstring Creation date updated_atstring Update date namestring Name custom_objectstring Custom object descriptionstring Description api_namestring API name data_typejson Data type configuration is_uniqueboolean Is unique is_immutableboolean Is immutable is_standardboolean Is standard enable_historyboolean History enabled managed_package_install_idstring Package install ID
Delete a field from a custom object
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name fieldApiNamestring Yes Field API name
Parameter Type Description deletedboolean Whether the field was deleted
List all records for a custom object
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name
Parameter Type Description recordsarray 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 totalCountnumber Number of records returned nextLinkstring Next page link
Get a specific custom object record
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name codrIdstring Yes Record ID
Parameter Type Description idstring Record ID created_atstring Record creation date updated_atstring Record update date namestring Record name external_idstring External ID created_byjson Created by user (id, display_value, image) last_modified_byjson Last modified by user (id, display_value, image) owner_rolejson Owner role (id, display_value, image) system_updated_atstring System update timestamp datajson Full record data
Get a custom object record by external ID
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name externalIdstring Yes External ID
Parameter Type Description idstring Record ID created_atstring Record creation date updated_atstring Record update date namestring Record name external_idstring External ID created_byjson Created by user (id, display_value, image) last_modified_byjson Last modified by user (id, display_value, image) owner_rolejson Owner role (id, display_value, image) system_updated_atstring System update timestamp datajson Full record data
Query custom object records with filters
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name querystring No Query expression limitnumber No Maximum number of records to return cursorstring No Pagination cursor
Parameter Type Description recordsarray 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 totalCountnumber Number of records returned cursorstring Cursor for next page of results
Create a custom object record
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name externalIdstring No External ID for the record datajson Yes Record data
Parameter Type Description idstring Record ID created_atstring Record creation date updated_atstring Record update date namestring Record name external_idstring External ID created_byjson Created by user (id, display_value, image) last_modified_byjson Last modified by user (id, display_value, image) owner_rolejson Owner role (id, display_value, image) system_updated_atstring System update timestamp datajson Full record data
Update a custom object record
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name codrIdstring Yes Record ID externalIdstring No External ID for the record datajson No Updated record data
Parameter Type Description idstring Record ID created_atstring Record creation date updated_atstring Record update date namestring Record name external_idstring External ID created_byjson Created by user (id, display_value, image) last_modified_byjson Last modified by user (id, display_value, image) owner_rolejson Owner role (id, display_value, image) system_updated_atstring System update timestamp datajson Full record data
Delete a custom object record
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name codrIdstring Yes Record ID
Parameter Type Description deletedboolean Whether the record was deleted
Bulk create custom object records
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name rowsToWritejson Yes Array of records to create [{external_id?, data}] allOrNothingboolean No If true, fail entire batch on any error
Parameter Type Description createdRecordsarray Created custom object records totalCountnumber Number of records created
Bulk update custom object records
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name rowsToUpdatejson Yes Array of records to update allOrNothingboolean No If true, fail entire batch on any error
Parameter Type Description updatedRecordsarray Updated custom object records totalCountnumber Number of records updated
Bulk delete custom object records
Parameter Type Required Description apiKeystring Yes Rippling API key customObjectApiNamestring Yes Custom object API name rowsToDeletejson Yes Array of records to delete allOrNothingboolean No If true, fail entire batch on any error
Parameter Type Description deletedboolean Whether the bulk delete succeeded
List all custom apps
Parameter Type Required Description apiKeystring Yes Rippling API key
Parameter Type Description customAppsarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific custom app
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID
Parameter Type Description idstring App ID created_atstring Creation date updated_atstring Update date namestring Name api_namestring API name descriptionstring Description iconstring Icon URL pagesjson Array of page summaries __metajson Metadata including redacted_fields
Create a new custom app
Parameter Type Required Description apiKeystring Yes Rippling API key namestring Yes App name apiNamestring Yes API name descriptionstring No Description
Parameter Type Description idstring App ID created_atstring Creation date updated_atstring Update date namestring Name api_namestring API name descriptionstring Description iconstring Icon URL pagesjson Array of page summaries
Update a custom app
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes App ID namestring No App name apiNamestring No API name descriptionstring No Description
Parameter Type Description idstring App ID created_atstring Creation date updated_atstring Update date namestring Name api_namestring API name descriptionstring Description iconstring Icon URL pagesjson Array of page summaries
Delete a custom app
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes ID of the resource to delete
Parameter Type Description deletedboolean Whether the resource was deleted
List all custom pages
Parameter Type Required Description apiKeystring Yes Rippling API key
Parameter Type Description customPagesarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific custom page
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID
Parameter Type Description idstring Page ID created_atstring Creation date updated_atstring Update date namestring Name componentsjson Page components actionsjson Page actions canvas_actionsjson Canvas actions variablesjson Page variables mediajson Page media __metajson Metadata including redacted_fields
Create a new custom page
Parameter Type Required Description apiKeystring Yes Rippling API key namestring Yes Page name
Parameter Type Description idstring Page ID created_atstring Creation date updated_atstring Update date namestring Name componentsjson Page components actionsjson Page actions canvas_actionsjson Canvas actions variablesjson Page variables mediajson Page media
Update a custom page
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Page ID namestring No Page name
Parameter Type Description idstring Page ID created_atstring Creation date updated_atstring Update date namestring Name componentsjson Page components actionsjson Page actions canvas_actionsjson Canvas actions variablesjson Page variables mediajson Page media
Delete a custom page
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes ID of the resource to delete
Parameter Type Description deletedboolean Whether the resource was deleted
List all custom settings
Parameter Type Required Description apiKeystring Yes Rippling API key orderBystring No Sort field. Prefix with - for descending cursorstring No Pagination cursor from previous response
Parameter Type Description customSettingsarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results __metajson Metadata including redacted_fields
Get a specific custom setting
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID
Parameter Type Description idstring Setting ID created_atstring Record creation date updated_atstring Record update date display_namestring Display name api_namestring API name data_typestring Data type secret_valuestring Secret value string_valuestring String value number_valuenumber Number value boolean_valueboolean Boolean value __metajson Metadata including redacted_fields
Create a new custom setting
Parameter Type Required Description apiKeystring Yes Rippling API key displayNamestring No Display name apiNamestring No Unique API name dataTypestring No Data type of the setting secretValuestring No Secret value (for secret data type) stringValuestring No String value (for string data type) numberValuenumber No Number value (for number data type) booleanValueboolean No Boolean value (for boolean data type)
Parameter Type Description idstring Setting ID created_atstring Record creation date updated_atstring Record update date display_namestring Display name api_namestring API name data_typestring Data type secret_valuestring Secret value string_valuestring String value number_valuenumber Number value boolean_valueboolean Boolean value
Update a custom setting
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Setting ID displayNamestring No Display name apiNamestring No Unique API name dataTypestring No Data type of the setting secretValuestring No Secret value (for secret data type) stringValuestring No String value (for string data type) numberValuenumber No Number value (for number data type) booleanValueboolean No Boolean value (for boolean data type)
Parameter Type Description idstring Setting ID created_atstring Record creation date updated_atstring Record update date display_namestring Display name api_namestring API name data_typestring Data type secret_valuestring Secret value string_valuestring String value number_valuenumber Number value boolean_valueboolean Boolean value
Delete a custom setting
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes ID of the resource to delete
Parameter Type Description deletedboolean Whether the resource was deleted
List all object categories
Parameter Type Required Description apiKeystring Yes Rippling API key
Parameter Type Description objectCategoriesarray 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 totalCountnumber Number of items returned nextLinkstring Link to next page of results
Get a specific object category
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Resource ID
Parameter Type Description idstring Category ID created_atstring Creation date updated_atstring Update date namestring Name descriptionstring Description
Create a new object category
Parameter Type Required Description apiKeystring Yes Rippling API key namestring Yes Category name descriptionstring No Description
Parameter Type Description idstring Category ID created_atstring Creation date updated_atstring Update date namestring Name descriptionstring Description
Update an object category
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes Category ID namestring No Category name descriptionstring No Description
Parameter Type Description idstring Category ID created_atstring Creation date updated_atstring Update date namestring Name descriptionstring Description
Delete an object category
Parameter Type Required Description apiKeystring Yes Rippling API key idstring Yes ID of the resource to delete
Parameter Type Description deletedboolean Whether the resource was deleted
Get a report run by ID
Parameter Type Required Description apiKeystring Yes Rippling API key runIdstring Yes run id
Parameter Type Description idstring Report run ID report_idstring Report ID statusstring Run status file_urlstring URL to download the report file expires_atstring Expiration timestamp for the file URL output_typestring Output format (JSON or CSV) __metajson Metadata including redacted_fields
Trigger a new report run
Parameter Type Required Description apiKeystring Yes Rippling API key reportIdstring Yes Report ID to run includeObjectIdsboolean No Include object IDs in the report includeTotalRowsboolean No Include total row count formatDateFieldsjson No Date field formatting configuration formatCurrencyFieldsjson No Currency field formatting configuration outputTypestring No Output type (JSON or CSV)
Parameter Type Description idstring Report run ID report_idstring Report ID statusstring Run status file_urlstring URL to download the report file expires_atstring Expiration timestamp for the file URL output_typestring Output format (JSON or CSV)
Create bulk draft hires
Parameter Type Required Description apiKeystring Yes Rippling API key draftHiresjson Yes Array of draft hire objects
Parameter Type Description invalidItemsjson Failed draft hires successfulResultsjson Successful draft hires totalInvalidnumber Number of failures totalSuccessfulnumber Number of successes
