@@ -88,6 +88,15 @@ List all workers with optional filtering and pagination
8888| ↳ ` overtime_exemption ` | string | Overtime exemption status \( EXEMPT, NON_EXEMPT\) |
8989| ↳ ` title_effective_date ` | string | Title effective date |
9090| ↳ ` business_partners_id ` | json | Array of business partner IDs |
91+ | ↳ ` location ` | json | Worker location \( type, work_location_id\) |
92+ | ↳ ` gender ` | string | Gender |
93+ | ↳ ` date_of_birth ` | string | Date of birth |
94+ | ↳ ` race ` | string | Race |
95+ | ↳ ` ethnicity ` | string | Ethnicity |
96+ | ↳ ` citizenship ` | string | Citizenship country code |
97+ | ↳ ` termination_details ` | json | Termination details |
98+ | ↳ ` custom_fields ` | json | Custom fields \( expandable\) |
99+ | ↳ ` country_fields ` | json | Country-specific fields |
91100| ` totalCount ` | number | Number of items returned |
92101| ` nextLink ` | string | Link to next page of results |
93102
@@ -130,6 +139,15 @@ Get a specific worker by ID
130139| ` overtime_exemption ` | string | Overtime exemption |
131140| ` title_effective_date ` | string | Title effective date |
132141| ` business_partners_id ` | json | Business partner IDs |
142+ | ` location ` | json | Worker location |
143+ | ` gender ` | string | Gender |
144+ | ` date_of_birth ` | string | Date of birth |
145+ | ` race ` | string | Race |
146+ | ` ethnicity ` | string | Ethnicity |
147+ | ` citizenship ` | string | Citizenship |
148+ | ` termination_details ` | json | Termination details |
149+ | ` custom_fields ` | json | Custom fields |
150+ | ` country_fields ` | json | Country-specific fields |
133151
134152### ` rippling_list_users `
135153
@@ -158,6 +176,11 @@ List all users with optional pagination
158176| ↳ ` locale ` | string | Locale |
159177| ↳ ` timezone ` | string | Timezone \( IANA format\) |
160178| ↳ ` number ` | string | Permanent profile number |
179+ | ↳ ` name ` | json | User name object \( given_name, family_name, etc.\) |
180+ | ↳ ` emails ` | json | Array of email objects |
181+ | ↳ ` phone_numbers ` | json | Array of phone number objects |
182+ | ↳ ` addresses ` | json | Array of address objects |
183+ | ↳ ` photos ` | json | Array of photo objects |
161184| ` totalCount ` | number | Number of items returned |
162185| ` nextLink ` | string | Link to next page of results |
163186
@@ -186,6 +209,11 @@ Get a specific user by ID
186209| ` locale ` | string | Locale |
187210| ` timezone ` | string | Timezone |
188211| ` number ` | string | Profile number |
212+ | ` name ` | json | User name object |
213+ | ` emails ` | json | Email addresses |
214+ | ` phone_numbers ` | json | Phone numbers |
215+ | ` addresses ` | json | Addresses |
216+ | ` photos ` | json | Photos |
189217
190218### ` rippling_list_companies `
191219
@@ -215,6 +243,7 @@ List all companies
215243| ↳ ` primary_email ` | string | Primary email |
216244| ↳ ` parent_legal_entity_id ` | string | Parent legal entity ID |
217245| ↳ ` legal_entities_id ` | json | Array of legal entity IDs |
246+ | ↳ ` physical_address ` | json | Physical address of the holding entity |
218247| ` totalCount ` | number | Number of items returned |
219248| ` nextLink ` | string | Link to next page of results |
220249
@@ -962,6 +991,17 @@ List all supergroups
962991| ↳ ` app_owner_id ` | string | App owner ID |
963992| ↳ ` group_type ` | string | Group type |
964993| ↳ ` name ` | string | Name |
994+ | ↳ ` sub_group_type ` | string | Sub group type |
995+ | ↳ ` read_only ` | boolean | Whether the group is read only |
996+ | ↳ ` parent ` | string | Parent group ID |
997+ | ↳ ` mutually_exclusive_key ` | string | Mutually exclusive key |
998+ | ↳ ` cumulatively_exhaustive_default ` | boolean | Whether the group is the cumulatively exhaustive default |
999+ | ↳ ` include_terminated ` | boolean | Whether the group includes terminated roles |
1000+ | ↳ ` allow_non_employees ` | boolean | Whether the group allows non-employees |
1001+ | ↳ ` can_override_role_states ` | boolean | Whether the group can override role states |
1002+ | ↳ ` priority ` | number | Group priority |
1003+ | ↳ ` is_invisible ` | boolean | Whether the group is invisible |
1004+ | ↳ ` ignore_prov_group_matching ` | boolean | Whether to ignore provisioning group matching |
9651005| ` totalCount ` | number | Number of items returned |
9661006| ` nextLink ` | string | Link to next page of results |
9671007
@@ -988,6 +1028,17 @@ Get a specific supergroup by ID
9881028| ` app_owner_id ` | string | App owner ID |
9891029| ` group_type ` | string | Group type |
9901030| ` name ` | string | Name |
1031+ | ` sub_group_type ` | string | Sub group type |
1032+ | ` read_only ` | boolean | Whether the group is read only |
1033+ | ` parent ` | string | Parent group ID |
1034+ | ` mutually_exclusive_key ` | string | Mutually exclusive key |
1035+ | ` cumulatively_exhaustive_default ` | boolean | Cumulatively exhaustive default |
1036+ | ` include_terminated ` | boolean | Whether the group includes terminated roles |
1037+ | ` allow_non_employees ` | boolean | Whether the group allows non-employees |
1038+ | ` can_override_role_states ` | boolean | Whether the group can override role states |
1039+ | ` priority ` | number | Group priority |
1040+ | ` is_invisible ` | boolean | Whether the group is invisible |
1041+ | ` ignore_prov_group_matching ` | boolean | Whether to ignore provisioning group matching |
9911042
9921043### ` rippling_list_supergroup_members `
9931044
@@ -1013,6 +1064,7 @@ List members of a supergroup
10131064| ↳ ` full_name ` | string | Full name |
10141065| ↳ ` work_email ` | string | Work email |
10151066| ↳ ` worker_id ` | string | Worker ID |
1067+ | ↳ ` worker ` | json | Expanded worker object |
10161068| ` totalCount ` | number | Number of members returned |
10171069| ` nextLink ` | string | Next page link |
10181070
@@ -1040,6 +1092,7 @@ List inclusion members of a supergroup
10401092| ↳ ` full_name ` | string | Full name |
10411093| ↳ ` work_email ` | string | Work email |
10421094| ↳ ` worker_id ` | string | Worker ID |
1095+ | ↳ ` worker ` | json | Expanded worker object |
10431096| ` totalCount ` | number | Number of members returned |
10441097| ` nextLink ` | string | Next page link |
10451098
@@ -1067,6 +1120,7 @@ List exclusion members of a supergroup
10671120| ↳ ` full_name ` | string | Full name |
10681121| ↳ ` work_email ` | string | Work email |
10691122| ↳ ` worker_id ` | string | Worker ID |
1123+ | ↳ ` worker ` | json | Expanded worker object |
10701124| ` totalCount ` | number | Number of members returned |
10711125| ` nextLink ` | string | Next page link |
10721126
@@ -1129,6 +1183,9 @@ List all custom objects
11291183| ↳ ` api_name ` | string | API name |
11301184| ↳ ` plural_label ` | string | Plural label |
11311185| ↳ ` category_id ` | string | Category ID |
1186+ | ↳ ` native_category_id ` | string | Native category ID |
1187+ | ↳ ` managed_package_install_id ` | string | Package install ID |
1188+ | ↳ ` owner_id ` | string | Owner ID |
11321189| ↳ ` enable_history ` | boolean | Whether history is enabled |
11331190| ` totalCount ` | number | Number of items returned |
11341191| ` nextLink ` | string | Link to next page of results |
@@ -1157,6 +1214,9 @@ Get a custom object by API name
11571214| ` plural_label ` | string | Plural label |
11581215| ` category_id ` | string | Category ID |
11591216| ` enable_history ` | boolean | History enabled |
1217+ | ` native_category_id ` | string | Native category ID |
1218+ | ` managed_package_install_id ` | string | Package install ID |
1219+ | ` owner_id ` | string | Owner ID |
11601220
11611221### ` rippling_create_custom_object `
11621222
@@ -1184,6 +1244,9 @@ Create a new custom object
11841244| ` plural_label ` | string | Plural label |
11851245| ` category_id ` | string | Category ID |
11861246| ` enable_history ` | boolean | History enabled |
1247+ | ` native_category_id ` | string | Native category ID |
1248+ | ` managed_package_install_id ` | string | Package install ID |
1249+ | ` owner_id ` | string | Owner ID |
11871250
11881251### ` rippling_update_custom_object `
11891252
@@ -1214,6 +1277,9 @@ Update a custom object
12141277| ` plural_label ` | string | Plural label |
12151278| ` category_id ` | string | Category ID |
12161279| ` enable_history ` | boolean | History enabled |
1280+ | ` native_category_id ` | string | Native category ID |
1281+ | ` managed_package_install_id ` | string | Package install ID |
1282+ | ` owner_id ` | string | Owner ID |
12171283
12181284### ` rippling_delete_custom_object `
12191285
@@ -1260,6 +1326,7 @@ List all fields for a custom object
12601326| ↳ ` is_immutable ` | boolean | Whether the field is immutable |
12611327| ↳ ` is_standard ` | boolean | Whether the field is standard |
12621328| ↳ ` enable_history ` | boolean | Whether history is enabled |
1329+ | ↳ ` managed_package_install_id ` | string | Package install ID |
12631330| ` totalCount ` | number | Number of fields returned |
12641331| ` nextLink ` | string | Next page link |
12651332
@@ -1291,6 +1358,7 @@ Get a specific field of a custom object
12911358| ` is_immutable ` | boolean | Is immutable |
12921359| ` is_standard ` | boolean | Is standard |
12931360| ` enable_history ` | boolean | History enabled |
1361+ | ` managed_package_install_id ` | string | Package install ID |
12941362
12951363### ` rippling_create_custom_object_field `
12961364
@@ -1324,6 +1392,7 @@ Create a field on a custom object
13241392| ` is_immutable ` | boolean | Is immutable |
13251393| ` is_standard ` | boolean | Is standard |
13261394| ` enable_history ` | boolean | History enabled |
1395+ | ` managed_package_install_id ` | string | Package install ID |
13271396
13281397### ` rippling_update_custom_object_field `
13291398
@@ -1358,6 +1427,7 @@ Update a field on a custom object
13581427| ` is_immutable ` | boolean | Is immutable |
13591428| ` is_standard ` | boolean | Is standard |
13601429| ` enable_history ` | boolean | History enabled |
1430+ | ` managed_package_install_id ` | string | Package install ID |
13611431
13621432### ` rippling_delete_custom_object_field `
13631433
@@ -1621,6 +1691,8 @@ List all custom apps
16211691| ↳ ` name ` | string | App name |
16221692| ↳ ` api_name ` | string | API name |
16231693| ↳ ` description ` | string | Description |
1694+ | ↳ ` icon ` | string | Icon URL |
1695+ | ↳ ` pages ` | json | Array of page summaries |
16241696| ` totalCount ` | number | Number of items returned |
16251697| ` nextLink ` | string | Link to next page of results |
16261698
@@ -1645,6 +1717,8 @@ Get a specific custom app
16451717| ` name ` | string | Name |
16461718| ` api_name ` | string | API name |
16471719| ` description ` | string | Description |
1720+ | ` icon ` | string | Icon URL |
1721+ | ` pages ` | json | Array of page summaries |
16481722
16491723### ` rippling_create_custom_app `
16501724
@@ -1669,6 +1743,8 @@ Create a new custom app
16691743| ` name ` | string | Name |
16701744| ` api_name ` | string | API name |
16711745| ` description ` | string | Description |
1746+ | ` icon ` | string | Icon URL |
1747+ | ` pages ` | json | Array of page summaries |
16721748
16731749### ` rippling_update_custom_app `
16741750
@@ -1694,6 +1770,8 @@ Update a custom app
16941770| ` name ` | string | Name |
16951771| ` api_name ` | string | API name |
16961772| ` description ` | string | Description |
1773+ | ` icon ` | string | Icon URL |
1774+ | ` pages ` | json | Array of page summaries |
16971775
16981776### ` rippling_delete_custom_app `
16991777
@@ -1731,6 +1809,11 @@ List all custom pages
17311809| ↳ ` created_at ` | string | Record creation date |
17321810| ↳ ` updated_at ` | string | Record update date |
17331811| ↳ ` name ` | string | Page name |
1812+ | ↳ ` components ` | json | Page components |
1813+ | ↳ ` actions ` | json | Page actions |
1814+ | ↳ ` canvas_actions ` | json | Canvas actions |
1815+ | ↳ ` variables ` | json | Page variables |
1816+ | ↳ ` media ` | json | Page media |
17341817| ` totalCount ` | number | Number of items returned |
17351818| ` nextLink ` | string | Link to next page of results |
17361819
@@ -1753,6 +1836,11 @@ Get a specific custom page
17531836| ` created_at ` | string | Creation date |
17541837| ` updated_at ` | string | Update date |
17551838| ` name ` | string | Name |
1839+ | ` components ` | json | Page components |
1840+ | ` actions ` | json | Page actions |
1841+ | ` canvas_actions ` | json | Canvas actions |
1842+ | ` variables ` | json | Page variables |
1843+ | ` media ` | json | Page media |
17561844
17571845### ` rippling_create_custom_page `
17581846
@@ -1773,6 +1861,11 @@ Create a new custom page
17731861| ` created_at ` | string | Creation date |
17741862| ` updated_at ` | string | Update date |
17751863| ` name ` | string | Name |
1864+ | ` components ` | json | Page components |
1865+ | ` actions ` | json | Page actions |
1866+ | ` canvas_actions ` | json | Canvas actions |
1867+ | ` variables ` | json | Page variables |
1868+ | ` media ` | json | Page media |
17761869
17771870### ` rippling_update_custom_page `
17781871
@@ -1794,6 +1887,11 @@ Update a custom page
17941887| ` created_at ` | string | Creation date |
17951888| ` updated_at ` | string | Update date |
17961889| ` name ` | string | Name |
1890+ | ` components ` | json | Page components |
1891+ | ` actions ` | json | Page actions |
1892+ | ` canvas_actions ` | json | Canvas actions |
1893+ | ` variables ` | json | Page variables |
1894+ | ` media ` | json | Page media |
17971895
17981896### ` rippling_delete_custom_page `
17991897
@@ -1884,7 +1982,15 @@ Create a new custom setting
18841982| Parameter | Type | Description |
18851983| --------- | ---- | ----------- |
18861984| ` id ` | string | Setting ID |
1887- | ` data ` | json | Full setting data |
1985+ | ` created_at ` | string | Created timestamp |
1986+ | ` updated_at ` | string | Updated timestamp |
1987+ | ` display_name ` | string | Display name |
1988+ | ` api_name ` | string | API name |
1989+ | ` data_type ` | string | Data type |
1990+ | ` secret_value ` | string | Secret value |
1991+ | ` string_value ` | string | String value |
1992+ | ` number_value ` | number | Number value |
1993+ | ` boolean_value ` | boolean | Boolean value |
18881994
18891995### ` rippling_update_custom_setting `
18901996
@@ -1903,7 +2009,15 @@ Update a custom setting
19032009| Parameter | Type | Description |
19042010| --------- | ---- | ----------- |
19052011| ` id ` | string | Setting ID |
1906- | ` data ` | json | Full setting data |
2012+ | ` created_at ` | string | Created timestamp |
2013+ | ` updated_at ` | string | Updated timestamp |
2014+ | ` display_name ` | string | Display name |
2015+ | ` api_name ` | string | API name |
2016+ | ` data_type ` | string | Data type |
2017+ | ` secret_value ` | string | Secret value |
2018+ | ` string_value ` | string | String value |
2019+ | ` number_value ` | number | Number value |
2020+ | ` boolean_value ` | boolean | Boolean value |
19072021
19082022### ` rippling_delete_custom_setting `
19092023
@@ -2058,6 +2172,11 @@ Trigger a new report run
20582172| --------- | ---- | -------- | ----------- |
20592173| ` apiKey ` | string | Yes | Rippling API key |
20602174| ` reportId ` | string | Yes | Report ID to run |
2175+ | ` includeObjectIds ` | boolean | No | Include object IDs in the report |
2176+ | ` includeTotalRows ` | boolean | No | Include total row count |
2177+ | ` formatDateFields ` | json | No | Date field formatting configuration |
2178+ | ` formatCurrencyFields ` | json | No | Currency field formatting configuration |
2179+ | ` outputType ` | string | No | Output type \( JSON or CSV\) |
20612180
20622181#### Output
20632182
0 commit comments