Rippling
Manage workers, departments, custom objects, and company data in Rippling
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.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
filter | string | No | No description |
expand | string | No | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
workers | array | List of workers |
↳ id | string | Worker ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ user_id | string | Associated user ID |
↳ is_manager | boolean | Whether the worker is a manager |
↳ manager_id | string | Manager worker ID |
↳ legal_entity_id | string | Legal entity ID |
↳ country | string | Worker country code |
↳ start_date | string | Employment start date |
↳ end_date | string | Employment end date |
↳ number | number | Worker number |
↳ work_email | string | Work email address |
↳ personal_email | string | Personal email address |
↳ status | string | Worker status (INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED) |
↳ employment_type_id | string | Employment type ID |
↳ department_id | string | Department ID |
↳ teams_id | json | Array of team IDs |
↳ title | string | Job title |
↳ level_id | string | Level ID |
↳ compensation_id | string | Compensation ID |
↳ overtime_exemption | string | Overtime exemption status (EXEMPT, NON_EXEMPT) |
↳ title_effective_date | string | Title effective date |
↳ business_partners_id | json | Array of business partner IDs |
↳ location | json | Worker location (type, work_location_id) |
↳ gender | string | Gender |
↳ date_of_birth | string | Date of birth |
↳ race | string | Race |
↳ ethnicity | string | Ethnicity |
↳ citizenship | string | Citizenship country code |
↳ termination_details | json | Termination details |
↳ custom_fields | json | Custom fields (expandable) |
↳ country_fields | json | Country-specific fields |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
expand | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Worker ID |
created_at | string | Creation date |
updated_at | string | Update date |
user_id | string | User ID |
is_manager | boolean | Is manager |
manager_id | string | Manager ID |
legal_entity_id | string | Legal entity ID |
country | string | Country |
start_date | string | Start date |
end_date | string | End date |
number | number | Worker number |
work_email | string | Work email |
personal_email | string | Personal email |
status | string | Status |
employment_type_id | string | Employment type ID |
department_id | string | Department ID |
teams_id | json | Team IDs |
title | string | Job title |
level_id | string | Level ID |
compensation_id | string | Compensation ID |
overtime_exemption | string | Overtime exemption |
title_effective_date | string | Title effective date |
business_partners_id | json | Business partner IDs |
location | json | Worker location |
gender | string | Gender |
date_of_birth | string | Date of birth |
race | string | Race |
ethnicity | string | Ethnicity |
citizenship | string | Citizenship |
termination_details | json | Termination details |
custom_fields | json | Custom fields |
country_fields | json | Country-specific fields |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
users | array | List of users |
↳ id | string | User ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ active | boolean | Whether the user is active |
↳ username | string | Unique username |
↳ display_name | string | Display name |
↳ preferred_language | string | Preferred language |
↳ locale | string | Locale |
↳ timezone | string | Timezone (IANA format) |
↳ number | string | Permanent profile number |
↳ name | json | User name object (given_name, family_name, etc.) |
↳ emails | json | Array of email objects |
↳ phone_numbers | json | Array of phone number objects |
↳ addresses | json | Array of address objects |
↳ photos | json | Array of photo objects |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | User ID |
created_at | string | Creation date |
updated_at | string | Update date |
active | boolean | Is active |
username | string | Username |
display_name | string | Display name |
preferred_language | string | Preferred language |
locale | string | Locale |
timezone | string | Timezone |
number | string | Profile number |
name | json | User name object |
emails | json | Email addresses |
phone_numbers | json | Phone numbers |
addresses | json | Addresses |
photos | json | Photos |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
expand | string | No | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
companies | array | List of companies |
↳ id | string | Company ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Company name |
↳ legal_name | string | Legal name |
↳ doing_business_as_name | string | DBA name |
↳ phone | string | Phone number |
↳ primary_email | string | Primary email |
↳ parent_legal_entity_id | string | Parent legal entity ID |
↳ legal_entities_id | json | Array of legal entity IDs |
↳ physical_address | json | Physical address of the holding entity |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
expand | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | User ID |
created_at | string | Creation date |
updated_at | string | Update date |
work_email | string | Work email |
company_id | string | Company ID |
company | json | Expanded company object |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
entitlements | array | List of entitlements |
↳ id | string | Entitlement ID |
↳ description | string | Entitlement description |
↳ display_name | string | Display name |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
expand | string | No | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
departments | array | List of departments |
↳ id | string | Department ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Department name |
↳ parent_id | string | Parent department ID |
↳ reference_code | string | Reference code |
↳ department_hierarchy_id | json | Array of department IDs in hierarchy |
↳ parent | json | Expanded parent department |
↳ department_hierarchy | json | Expanded department hierarchy |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
expand | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Department ID |
created_at | string | Record creation date |
updated_at | string | Record update date |
name | string | Department name |
parent_id | string | Parent department ID |
reference_code | string | Reference code |
department_hierarchy_id | json | Array of department IDs in hierarchy |
parent | json | Expanded parent department |
department_hierarchy | json | Expanded department hierarchy |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
parentId | string | No | No description |
referenceCode | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Department ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
parent_id | string | Parent department ID |
reference_code | string | Reference code |
department_hierarchy_id | json | Department hierarchy IDs |
parent | json | Expanded parent department |
department_hierarchy | json | Expanded department hierarchy |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
name | string | No | No description |
parentId | string | No | No description |
referenceCode | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | id output from the tool |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
parent_id | string | Parent department ID |
reference_code | string | Reference code |
department_hierarchy_id | json | Department hierarchy IDs |
parent | json | Expanded parent department |
department_hierarchy | json | Expanded department hierarchy |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
expand | string | No | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
teams | array | List of teams |
↳ id | string | Team ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Team name |
↳ parent_id | string | Parent team ID |
↳ parent | json | Expanded parent team |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
expand | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Team ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
parent_id | string | Parent team ID |
parent | json | Expanded parent team |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
employmentTypes | array | List of employmentTypes |
↳ id | string | Employment type ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ label | string | Employment type label |
↳ name | string | Employment type name |
↳ type | string | Type (CONTRACTOR, EMPLOYEE) |
↳ compensation_time_period | string | Compensation period (HOURLY, SALARIED) |
↳ amount_worked | string | Amount worked (PART-TIME, FULL-TIME, TEMPORARY) |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Employment type ID |
created_at | string | Creation date |
updated_at | string | Update date |
label | string | Label |
name | string | Name |
type | string | Type (CONTRACTOR, EMPLOYEE) |
compensation_time_period | string | Compensation period (HOURLY, SALARIED) |
amount_worked | string | Amount worked (PART-TIME, FULL-TIME, TEMPORARY) |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
titles | array | List of titles |
↳ id | string | Title ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Title name |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Title ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Title name |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Title ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | name output from the tool |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
name | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | id output from the tool |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | name output from the tool |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the resource was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
customFields | array | List of customFields |
↳ id | string | Custom field ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Field name |
↳ description | string | Field description |
↳ required | boolean | Whether the field is required |
↳ type | string | Field type (TEXT, DATE, NUMBER, CURRENCY, etc.) |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
jobFunctions | array | List of jobFunctions |
↳ id | string | Job function ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Job function name |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Job function ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
workLocations | array | List of workLocations |
↳ id | string | Work location ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Location name |
↳ address | json | Address object |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Location ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
address | json | Address object |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
streetAddress | string | Yes | No description |
locality | string | No | No description |
region | string | No | No description |
postalCode | string | No | No description |
country | string | No | No description |
addressType | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Location ID |
created_at | string | Created timestamp |
updated_at | string | Updated timestamp |
name | string | Name |
address | json | Address |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
name | string | No | No description |
streetAddress | string | No | No description |
locality | string | No | No description |
region | string | No | No description |
postalCode | string | No | No description |
country | string | No | No description |
addressType | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | id output from the tool |
created_at | string | Created timestamp |
updated_at | string | Updated timestamp |
name | string | Name |
address | json | Address |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the resource was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
filter | string | No | No description |
expand | string | No | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
businessPartners | array | List of businessPartners |
↳ id | string | Business partner ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ business_partner_group_id | string | Business partner group ID |
↳ worker_id | string | Worker ID |
↳ client_group_id | string | Client group ID |
↳ client_group_member_count | number | Client group member count |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
expand | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | ID |
created_at | string | Creation date |
updated_at | string | Update date |
business_partner_group_id | string | Group ID |
worker_id | string | Worker ID |
client_group_id | string | Client group ID |
client_group_member_count | number | Client group member count |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
businessPartnerGroupId | string | Yes | No description |
workerId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | ID |
created_at | string | Creation date |
updated_at | string | Update date |
business_partner_group_id | string | Group ID |
worker_id | string | Worker ID |
client_group_id | string | Client group ID |
client_group_member_count | number | Client group member count |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the resource was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
expand | string | No | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
businessPartnerGroups | array | List of businessPartnerGroups |
↳ id | string | Business partner group ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Group name |
↳ domain | string | Domain (HR, IT, FINANCE, RECRUITING, OTHER) |
↳ default_business_partner_id | string | Default business partner ID |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
expand | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
domain | string | Domain |
default_business_partner_id | string | Default partner ID |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
domain | string | No | No description |
defaultBusinessPartnerId | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
domain | string | Domain |
default_business_partner_id | string | Default partner ID |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the resource was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
filter | string | No | No description |
orderBy | string | No | No description |
| Parameter | Type | Description |
|---|
supergroups | array | List of supergroups |
↳ id | string | Supergroup ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ display_name | string | Display name |
↳ description | string | Description |
↳ app_owner_id | string | App owner ID |
↳ group_type | string | Group type |
↳ name | string | Name |
↳ sub_group_type | string | Sub group type |
↳ read_only | boolean | Whether the group is read only |
↳ parent | string | Parent group ID |
↳ mutually_exclusive_key | string | Mutually exclusive key |
↳ cumulatively_exhaustive_default | boolean | Whether the group is the cumulatively exhaustive default |
↳ include_terminated | boolean | Whether the group includes terminated roles |
↳ allow_non_employees | boolean | Whether the group allows non-employees |
↳ can_override_role_states | boolean | Whether the group can override role states |
↳ priority | number | Group priority |
↳ is_invisible | boolean | Whether the group is invisible |
↳ ignore_prov_group_matching | boolean | Whether to ignore provisioning group matching |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Supergroup ID |
created_at | string | Record creation date |
updated_at | string | Record update date |
display_name | string | Display name |
description | string | Description |
app_owner_id | string | App owner ID |
group_type | string | Group type |
name | string | Name |
sub_group_type | string | Sub group type |
read_only | boolean | Whether the group is read only |
parent | string | Parent group ID |
mutually_exclusive_key | string | Mutually exclusive key |
cumulatively_exhaustive_default | boolean | Whether the group is the cumulatively exhaustive default |
include_terminated | boolean | Whether the group includes terminated roles |
allow_non_employees | boolean | Whether the group allows non-employees |
can_override_role_states | boolean | Whether the group can override role states |
priority | number | Group priority |
is_invisible | boolean | Whether the group is invisible |
ignore_prov_group_matching | boolean | Whether to ignore provisioning group matching |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
groupId | string | Yes | No description |
expand | string | No | No description |
orderBy | string | No | No description |
| Parameter | Type | Description |
|---|
members | array | List of members |
↳ id | string | Member ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ full_name | string | Full name |
↳ work_email | string | Work email |
↳ worker_id | string | Worker ID |
↳ worker | json | Expanded worker object |
totalCount | number | Number of members returned |
nextLink | string | Next page link |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
groupId | string | Yes | No description |
expand | string | No | No description |
orderBy | string | No | No description |
| Parameter | Type | Description |
|---|
members | array | List of members |
↳ id | string | Member ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ full_name | string | Full name |
↳ work_email | string | Work email |
↳ worker_id | string | Worker ID |
↳ worker | json | Expanded worker object |
totalCount | number | Number of members returned |
nextLink | string | Next page link |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
groupId | string | Yes | No description |
expand | string | No | No description |
orderBy | string | No | No description |
| Parameter | Type | Description |
|---|
members | array | List of members |
↳ id | string | Member ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ full_name | string | Full name |
↳ work_email | string | Work email |
↳ worker_id | string | Worker ID |
↳ worker | json | Expanded worker object |
totalCount | number | Number of members returned |
nextLink | string | Next page link |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
groupId | string | Yes | No description |
operations | json | Yes | Operations array [{op: "add"|"remove", value: [{id: "member_id"}]}] |
| Parameter | Type | Description |
|---|
ok | boolean | Whether the operation succeeded |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
groupId | string | Yes | No description |
operations | json | Yes | Operations array [{op: "add"|"remove", value: [{id: "member_id"}]}] |
| Parameter | Type | Description |
|---|
ok | boolean | Whether the operation succeeded |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
customObjects | array | List of customObjects |
↳ id | string | Custom object ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Object name |
↳ description | string | Description |
↳ api_name | string | API name |
↳ plural_label | string | Plural label |
↳ category_id | string | Category ID |
↳ native_category_id | string | Native category ID |
↳ managed_package_install_id | string | Package install ID |
↳ owner_id | string | Owner ID |
↳ enable_history | boolean | Whether history is enabled |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
description | string | Description |
api_name | string | API name |
plural_label | string | Plural label |
category_id | string | Category ID |
enable_history | boolean | History enabled |
native_category_id | string | Native category ID |
managed_package_install_id | string | Package install ID |
owner_id | string | Owner ID |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
description | string | No | No description |
category | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
description | string | description output from the tool |
api_name | string | API name |
plural_label | string | Plural label |
category_id | string | Category ID |
enable_history | boolean | History enabled |
native_category_id | string | Native category ID |
managed_package_install_id | string | Package install ID |
owner_id | string | Owner ID |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
name | string | No | No description |
description | string | No | No description |
category | string | No | No description |
pluralLabel | string | No | No description |
ownerRole | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | name output from the tool |
description | string | description output from the tool |
api_name | string | API name |
plural_label | string | Plural label |
category_id | string | Category ID |
enable_history | boolean | History enabled |
native_category_id | string | Native category ID |
managed_package_install_id | string | Package install ID |
owner_id | string | Owner ID |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the resource was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
| Parameter | Type | Description |
|---|
fields | array | List of fields |
↳ id | string | Field ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Field name |
↳ custom_object | string | Parent custom object |
↳ description | string | Description |
↳ api_name | string | API name |
↳ data_type | json | Data type configuration |
↳ is_unique | boolean | Whether the field is unique |
↳ is_immutable | boolean | Whether the field is immutable |
↳ is_standard | boolean | Whether the field is standard |
↳ enable_history | boolean | Whether history is enabled |
↳ managed_package_install_id | string | Package install ID |
totalCount | number | Number of fields returned |
nextLink | string | Next page link |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
fieldApiName | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Field ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
custom_object | string | Custom object |
description | string | Description |
api_name | string | API name |
data_type | json | Data type configuration |
is_unique | boolean | Is unique |
is_immutable | boolean | Is immutable |
is_standard | boolean | Is standard |
enable_history | boolean | History enabled |
managed_package_install_id | string | Package install ID |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
name | string | Yes | No description |
description | string | No | No description |
dataType | json | Yes | No description |
required | boolean | No | No description |
rqlDefinition | json | No | No description |
isUnique | boolean | No | No description |
formulaAttrMetas | json | No | No description |
section | json | No | No description |
enableHistory | boolean | No | No description |
derivedFieldFormula | string | No | No description |
derivedAggregatedField | json | No | No description |
| Parameter | Type | Description |
|---|
id | string | Field ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
custom_object | string | Custom object |
description | string | description output from the tool |
api_name | string | API name |
data_type | json | Data type configuration |
is_unique | boolean | Is unique |
is_immutable | boolean | Is immutable |
is_standard | boolean | Is standard |
enable_history | boolean | History enabled |
managed_package_install_id | string | Package install ID |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
fieldApiName | string | Yes | No description |
name | string | No | No description |
description | string | No | No description |
dataType | json | No | No description |
required | boolean | No | No description |
rqlDefinition | json | No | No description |
isUnique | boolean | No | No description |
formulaAttrMetas | json | No | No description |
section | json | No | No description |
enableHistory | boolean | No | No description |
derivedFieldFormula | string | No | No description |
nameFieldDetails | json | No | No description |
| Parameter | Type | Description |
|---|
id | string | Field ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
custom_object | string | Custom object |
description | string | description output from the tool |
api_name | string | API name |
data_type | json | Data type configuration |
is_unique | boolean | Is unique |
is_immutable | boolean | Is immutable |
is_standard | boolean | Is standard |
enable_history | boolean | History enabled |
managed_package_install_id | string | Package install ID |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
fieldApiName | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the field was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
| Parameter | Type | Description |
|---|
records | array | List of records |
↳ id | string | Record ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Record name |
↳ external_id | string | External ID |
↳ created_by | json | Created by user (id, display_value, image) |
↳ last_modified_by | json | Last modified by user (id, display_value, image) |
↳ owner_role | json | Owner role (id, display_value, image) |
↳ system_updated_at | string | System update timestamp |
↳ data | json | Full record data including dynamic fields |
totalCount | number | Number of records returned |
nextLink | string | Next page link |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
codrId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Record ID |
created_at | string | Record creation date |
updated_at | string | Record update date |
name | string | Record name |
external_id | string | External ID |
created_by | json | Created by user (id, display_value, image) |
last_modified_by | json | Last modified by user (id, display_value, image) |
owner_role | json | Owner role (id, display_value, image) |
system_updated_at | string | System update timestamp |
data | json | Full record data |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
externalId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Record ID |
created_at | string | Record creation date |
updated_at | string | Record update date |
name | string | Record name |
external_id | string | External ID |
created_by | json | Created by user (id, display_value, image) |
last_modified_by | json | Last modified by user (id, display_value, image) |
owner_role | json | Owner role (id, display_value, image) |
system_updated_at | string | System update timestamp |
data | json | Full record data |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
query | string | No | No description |
limit | number | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
records | array | Matching records |
↳ id | string | Record ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Record name |
↳ external_id | string | External ID |
↳ created_by | json | Created by user (id, display_value, image) |
↳ last_modified_by | json | Last modified by user (id, display_value, image) |
↳ owner_role | json | Owner role (id, display_value, image) |
↳ system_updated_at | string | System update timestamp |
↳ data | json | Full record data |
totalCount | number | Number of records returned |
cursor | string | Cursor for next page of results |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
externalId | string | No | No description |
data | json | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Record ID |
created_at | string | Record creation date |
updated_at | string | Record update date |
name | string | Record name |
external_id | string | External ID |
created_by | json | Created by user (id, display_value, image) |
last_modified_by | json | Last modified by user (id, display_value, image) |
owner_role | json | Owner role (id, display_value, image) |
system_updated_at | string | System update timestamp |
data | json | Full record data |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
codrId | string | Yes | No description |
externalId | string | No | No description |
data | json | No | No description |
| Parameter | Type | Description |
|---|
id | string | Record ID |
created_at | string | Record creation date |
updated_at | string | Record update date |
name | string | Record name |
external_id | string | External ID |
created_by | json | Created by user (id, display_value, image) |
last_modified_by | json | Last modified by user (id, display_value, image) |
owner_role | json | Owner role (id, display_value, image) |
system_updated_at | string | System update timestamp |
data | json | Full record data |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
codrId | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the record was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
rowsToWrite | json | Yes | No description |
allOrNothing | boolean | No | No description |
| Parameter | Type | Description |
|---|
createdRecords | array | Created custom object records |
totalCount | number | Number of records created |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
rowsToUpdate | json | Yes | No description |
allOrNothing | boolean | No | No description |
| Parameter | Type | Description |
|---|
updatedRecords | array | Updated custom object records |
totalCount | number | Number of records updated |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
customObjectApiName | string | Yes | No description |
rowsToDelete | json | Yes | No description |
allOrNothing | boolean | No | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the bulk delete succeeded |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
customApps | array | List of customApps |
↳ id | string | App ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | App name |
↳ api_name | string | API name |
↳ description | string | Description |
↳ icon | string | Icon URL |
↳ pages | json | Array of page summaries |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | App ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
api_name | string | API name |
description | string | Description |
icon | string | Icon URL |
pages | json | Array of page summaries |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
apiName | string | Yes | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | App ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
api_name | string | API name |
description | string | description output from the tool |
icon | string | Icon URL |
pages | json | Array of page summaries |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
name | string | No | No description |
apiName | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | id output from the tool |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
api_name | string | API name |
description | string | description output from the tool |
icon | string | Icon URL |
pages | json | Array of page summaries |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the resource was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
customPages | array | List of customPages |
↳ id | string | Page ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Page name |
↳ components | json | Page components |
↳ actions | json | Page actions |
↳ canvas_actions | json | Canvas actions |
↳ variables | json | Page variables |
↳ media | json | Page media |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Page ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
components | json | Page components |
actions | json | Page actions |
canvas_actions | json | Canvas actions |
variables | json | Page variables |
media | json | Page media |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Page ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
components | json | Page components |
actions | json | Page actions |
canvas_actions | json | Canvas actions |
variables | json | Page variables |
media | json | Page media |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
name | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | id output from the tool |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
components | json | Page components |
actions | json | Page actions |
canvas_actions | json | Canvas actions |
variables | json | Page variables |
media | json | Page media |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the resource was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
orderBy | string | No | No description |
cursor | string | No | No description |
| Parameter | Type | Description |
|---|
customSettings | array | List of custom settings |
↳ id | string | Setting ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ display_name | string | Display name |
↳ api_name | string | API name |
↳ data_type | string | Data type |
↳ secret_value | string | Secret value |
↳ string_value | string | String value |
↳ number_value | number | Number value |
↳ boolean_value | boolean | Boolean value |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Setting ID |
created_at | string | Record creation date |
updated_at | string | Record update date |
display_name | string | Display name |
api_name | string | API name |
data_type | string | Data type |
secret_value | string | Secret value |
string_value | string | String value |
number_value | number | Number value |
boolean_value | boolean | Boolean value |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
displayName | string | No | No description |
apiName | string | No | No description |
dataType | string | No | No description |
secretValue | string | No | No description |
stringValue | string | No | No description |
numberValue | number | No | No description |
booleanValue | boolean | No | No description |
| Parameter | Type | Description |
|---|
id | string | Setting ID |
created_at | string | Record creation date |
updated_at | string | Record update date |
display_name | string | Display name |
api_name | string | API name |
data_type | string | Data type |
secret_value | string | Secret value |
string_value | string | String value |
number_value | number | Number value |
boolean_value | boolean | Boolean value |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
displayName | string | No | No description |
apiName | string | No | No description |
dataType | string | No | No description |
secretValue | string | No | No description |
stringValue | string | No | No description |
numberValue | number | No | No description |
booleanValue | boolean | No | No description |
| Parameter | Type | Description |
|---|
id | string | Setting ID |
created_at | string | Record creation date |
updated_at | string | Record update date |
display_name | string | Display name |
api_name | string | API name |
data_type | string | Data type |
secret_value | string | Secret value |
string_value | string | String value |
number_value | number | Number value |
boolean_value | boolean | Boolean value |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the resource was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
objectCategories | array | List of objectCategories |
↳ id | string | Category ID |
↳ created_at | string | Record creation date |
↳ updated_at | string | Record update date |
↳ name | string | Category name |
↳ description | string | Description |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Category ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
description | string | Description |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Category ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
description | string | description output from the tool |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
name | string | No | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | id output from the tool |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
description | string | description output from the tool |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the resource was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
runId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Report run ID |
report_id | string | Report ID |
status | string | Run status |
file_url | string | URL to download the report file |
expires_at | string | Expiration timestamp for the file URL |
output_type | string | Output format (JSON or CSV) |
__meta | json | Metadata including redacted_fields |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
reportId | string | Yes | No description |
includeObjectIds | boolean | No | No description |
includeTotalRows | boolean | No | No description |
formatDateFields | json | No | No description |
formatCurrencyFields | json | No | No description |
outputType | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Report run ID |
report_id | string | Report ID |
status | string | Run status |
file_url | string | URL to download the report file |
expires_at | string | Expiration timestamp for the file URL |
output_type | string | Output format (JSON or CSV) |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
draftHires | json | Yes | No description |
| Parameter | Type | Description |
|---|
invalidItems | json | Failed draft hires |
successfulResults | json | Successful draft hires |
totalInvalid | number | Number of failures |
totalSuccessful | number | Number of successes |
