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.
List all workers with optional filtering and pagination
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
filter | string | いいえ | Filter expression |
expand | string | いいえ | Comma-separated fields to expand |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific worker by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
expand | string | いいえ | Comma-separated fields to expand |
| パラメータ | 型 | 説明 |
|---|
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 |
List all users with optional pagination
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific user by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No 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 |
List all companies
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
expand | string | いいえ | Comma-separated fields to expand |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get SSO information for the current user
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
expand | string | いいえ | Comma-separated fields to expand |
| パラメータ | 型 | 説明 |
|---|
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 |
List all entitlements
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
| パラメータ | 型 | 説明 |
|---|
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 |
List all departments
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
expand | string | いいえ | Comma-separated fields to expand |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific department by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
expand | string | いいえ | Comma-separated fields to expand |
| パラメータ | 型 | 説明 |
|---|
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 |
Create a new department
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
name | string | はい | Department name |
parentId | string | いいえ | Parent department ID |
referenceCode | string | いいえ | Reference code |
| パラメータ | 型 | 説明 |
|---|
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 |
Update an existing department
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
name | string | いいえ | Department name |
parentId | string | いいえ | Parent department ID |
referenceCode | string | いいえ | Reference code |
| パラメータ | 型 | 説明 |
|---|
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 |
List all teams
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
expand | string | いいえ | Comma-separated fields to expand |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific team by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
expand | string | いいえ | Comma-separated fields to expand |
| パラメータ | 型 | 説明 |
|---|
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 |
List all employment types
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific employment type by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No 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 |
List all titles
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific title by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No 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 |
Create a new title
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
name | string | はい | No description |
| パラメータ | 型 | 説明 |
|---|
id | string | Title ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Title name |
Update an existing title
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
name | string | いいえ | No description |
| パラメータ | 型 | 説明 |
|---|
id | string | Title ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Title name |
Delete a title
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | ID of the resource to delete |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the resource was deleted |
List all custom fields
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
List all job functions
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific job function by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No 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 |
List all work locations
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific work location by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No 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 |
Create a new work location
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
name | string | はい | Location name |
streetAddress | string | はい | Street address |
locality | string | いいえ | No description |
region | string | いいえ | State/region |
postalCode | string | いいえ | Postal code |
country | string | いいえ | Country code |
addressType | string | いいえ | Address type (HOME, WORK, OTHER) |
| パラメータ | 型 | 説明 |
|---|
id | string | Location ID |
created_at | string | Created timestamp |
updated_at | string | Updated timestamp |
name | string | Name |
address | json | Address |
Update a work location
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
name | string | いいえ | Location name |
streetAddress | string | いいえ | Street address |
locality | string | いいえ | No description |
region | string | いいえ | State/region |
postalCode | string | いいえ | Postal code |
country | string | いいえ | Country code |
addressType | string | いいえ | Address type (HOME, WORK, OTHER) |
| パラメータ | 型 | 説明 |
|---|
id | string | Location ID |
created_at | string | Created timestamp |
updated_at | string | Updated timestamp |
name | string | Name |
address | json | Address |
Delete a work location
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | ID of the resource to delete |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the resource was deleted |
List all business partners
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
filter | string | いいえ | Filter expression |
expand | string | いいえ | Comma-separated fields to expand |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific business partner by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
expand | string | いいえ | Comma-separated fields to expand |
| パラメータ | 型 | 説明 |
|---|
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 |
Create a new business partner
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
businessPartnerGroupId | string | はい | Business partner group ID |
workerId | string | はい | Worker ID |
| パラメータ | 型 | 説明 |
|---|
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 |
Delete a business partner
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | ID of the resource to delete |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the resource was deleted |
List all business partner groups
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
expand | string | いいえ | Comma-separated fields to expand |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific business partner group by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
expand | string | いいえ | Comma-separated fields to expand |
| パラメータ | 型 | 説明 |
|---|
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 |
Create a new business partner group
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
name | string | はい | Group name |
domain | string | いいえ | Domain (HR, IT, FINANCE, RECRUITING, OTHER) |
defaultBusinessPartnerId | string | いいえ | Default business partner ID |
| パラメータ | 型 | 説明 |
|---|
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 |
Delete a business partner group
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | ID of the resource to delete |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the resource was deleted |
List all supergroups
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
filter | string | いいえ | Filter expression (filterable fields: app_owner_id, group_type) |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific supergroup by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No 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 |
List members of a supergroup
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
groupId | string | はい | Supergroup ID |
expand | string | いいえ | Fields to expand (e.g., worker) |
orderBy | string | いいえ | Sort field |
| パラメータ | 型 | 説明 |
|---|
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 |
List inclusion members of a supergroup
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
groupId | string | はい | Supergroup ID |
expand | string | いいえ | Fields to expand (e.g., worker) |
orderBy | string | いいえ | Sort field |
| パラメータ | 型 | 説明 |
|---|
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 |
List exclusion members of a supergroup
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
groupId | string | はい | Supergroup ID |
expand | string | いいえ | Fields to expand (e.g., worker) |
orderBy | string | いいえ | Sort field |
| パラメータ | 型 | 説明 |
|---|
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 |
Update inclusion members of a supergroup
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
groupId | string | はい | Supergroup ID |
operations | json | はい | Operations array [{op: "add"|"remove", value: [{id: "member_id"}]}] |
| パラメータ | 型 | 説明 |
|---|
ok | boolean | Whether the operation succeeded |
Update exclusion members of a supergroup
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
groupId | string | はい | Supergroup ID |
operations | json | はい | Operations array [{op: "add"|"remove", value: [{id: "member_id"}]}] |
| パラメータ | 型 | 説明 |
|---|
ok | boolean | Whether the operation succeeded |
List all custom objects
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a custom object by API name
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | custom object api name |
| パラメータ | 型 | 説明 |
|---|
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 |
Create a new custom object
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
name | string | はい | No description |
description | string | いいえ | Description |
category | string | いいえ | Category |
| パラメータ | 型 | 説明 |
|---|
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 |
Update a custom object
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
name | string | いいえ | No description |
description | string | いいえ | Description |
category | string | いいえ | Category |
pluralLabel | string | いいえ | Plural label |
ownerRole | string | いいえ | Owner role |
| パラメータ | 型 | 説明 |
|---|
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 |
Delete a custom object
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | ID of the resource to delete |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the resource was deleted |
List all fields for a custom object
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific field of a custom object
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
fieldApiName | string | はい | Field API name |
| パラメータ | 型 | 説明 |
|---|
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 |
Create a field on a custom object
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
name | string | はい | Field name |
description | string | いいえ | Description |
dataType | json | はい | Data type configuration |
required | boolean | いいえ | Whether the field is required |
rqlDefinition | json | いいえ | RQL definition object |
isUnique | boolean | いいえ | Whether field is unique |
formulaAttrMetas | json | いいえ | Formula attribute metadata |
section | json | いいえ | Section configuration |
enableHistory | boolean | いいえ | Enable history tracking |
derivedFieldFormula | string | いいえ | Derived field formula expression |
derivedAggregatedField | json | いいえ | Derived aggregated field configuration |
| パラメータ | 型 | 説明 |
|---|
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 |
Update a field on a custom object
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
fieldApiName | string | はい | Field API name |
name | string | いいえ | Field name |
description | string | いいえ | Description |
dataType | json | いいえ | Data type |
required | boolean | いいえ | Whether the field is required |
rqlDefinition | json | いいえ | RQL definition object |
isUnique | boolean | いいえ | Is unique |
formulaAttrMetas | json | いいえ | Formula attribute metadata |
section | json | いいえ | Section configuration |
enableHistory | boolean | いいえ | Enable history |
derivedFieldFormula | string | いいえ | Derived field formula expression |
nameFieldDetails | json | いいえ | Name field details configuration |
| パラメータ | 型 | 説明 |
|---|
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 |
Delete a field from a custom object
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
fieldApiName | string | はい | Field API name |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the field was deleted |
List all records for a custom object
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific custom object record
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
codrId | string | はい | No 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 |
Get a custom object record by external ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
externalId | string | はい | External ID |
| パラメータ | 型 | 説明 |
|---|
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 |
Query custom object records with filters
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
query | string | いいえ | Query expression |
limit | number | いいえ | Maximum number of records to return |
cursor | string | いいえ | Pagination cursor |
| パラメータ | 型 | 説明 |
|---|
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 |
Create a custom object record
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
externalId | string | いいえ | External ID for the record |
data | json | はい | No 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 |
Update a custom object record
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
codrId | string | はい | Record ID |
externalId | string | いいえ | External ID for the record |
data | json | いいえ | Updated record data |
| パラメータ | 型 | 説明 |
|---|
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 |
Delete a custom object record
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
codrId | string | はい | Record ID |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the record was deleted |
Bulk create custom object records
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
rowsToWrite | json | はい | Array of records to create [{external_id?, data}] |
allOrNothing | boolean | いいえ | If true, fail entire batch on any error |
| パラメータ | 型 | 説明 |
|---|
createdRecords | array | Created custom object records |
totalCount | number | Number of records created |
Bulk update custom object records
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
rowsToUpdate | json | はい | Array of records to update |
allOrNothing | boolean | いいえ | If true, fail entire batch on any error |
| パラメータ | 型 | 説明 |
|---|
updatedRecords | array | Updated custom object records |
totalCount | number | Number of records updated |
Bulk delete custom object records
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
customObjectApiName | string | はい | Custom object API name |
rowsToDelete | json | はい | Array of records to delete |
allOrNothing | boolean | いいえ | If true, fail entire batch on any error |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the bulk delete succeeded |
List all custom apps
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific custom app
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No 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 |
Create a new custom app
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
name | string | はい | No description |
apiName | string | はい | No description |
description | string | いいえ | 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 |
Update a custom app
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
name | string | いいえ | No description |
apiName | string | いいえ | API name |
description | string | いいえ | 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 |
Delete a custom app
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | ID of the resource to delete |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the resource was deleted |
List all custom pages
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific custom page
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No 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 |
Create a new custom page
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
name | string | はい | No 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 |
Update a custom page
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
name | string | いいえ | No 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 |
Delete a custom page
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | ID of the resource to delete |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the resource was deleted |
List all custom settings
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
orderBy | string | いいえ | Sort field. Prefix with - for descending |
cursor | string | いいえ | Pagination cursor from previous response |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific custom setting
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No 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 |
Create a new custom setting
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
displayName | string | いいえ | Display name |
apiName | string | いいえ | Unique API name |
dataType | string | いいえ | Data type of the setting |
secretValue | string | いいえ | Secret value (for secret data type) |
stringValue | string | いいえ | String value (for string data type) |
numberValue | number | いいえ | Number value (for number data type) |
booleanValue | boolean | いいえ | Boolean value (for boolean data type) |
| パラメータ | 型 | 説明 |
|---|
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 |
Update a custom setting
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
displayName | string | いいえ | Display name |
apiName | string | いいえ | Unique API name |
dataType | string | いいえ | Data type of the setting |
secretValue | string | いいえ | Secret value (for secret data type) |
stringValue | string | いいえ | String value (for string data type) |
numberValue | number | いいえ | Number value (for number data type) |
booleanValue | boolean | いいえ | Boolean value (for boolean data type) |
| パラメータ | 型 | 説明 |
|---|
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 |
Delete a custom setting
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | ID of the resource to delete |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the resource was deleted |
List all object categories
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific object category
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
| パラメータ | 型 | 説明 |
|---|
id | string | Category ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
description | string | Description |
Create a new object category
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
name | string | はい | Category name |
description | string | いいえ | Description |
| パラメータ | 型 | 説明 |
|---|
id | string | Category ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
description | string | Description |
Update an object category
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | No description |
name | string | いいえ | Category name |
description | string | いいえ | Description |
| パラメータ | 型 | 説明 |
|---|
id | string | Category ID |
created_at | string | Creation date |
updated_at | string | Update date |
name | string | Name |
description | string | Description |
Delete an object category
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
id | string | はい | ID of the resource to delete |
| パラメータ | 型 | 説明 |
|---|
deleted | boolean | Whether the resource was deleted |
Get a report run by ID
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
runId | string | はい | No 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 |
Trigger a new report run
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
reportId | string | はい | Report ID to run |
includeObjectIds | boolean | いいえ | Include object IDs in the report |
includeTotalRows | boolean | いいえ | Include total row count |
formatDateFields | json | いいえ | Date field formatting configuration |
formatCurrencyFields | json | いいえ | Currency field formatting configuration |
outputType | string | いいえ | Output type (JSON or CSV) |
| パラメータ | 型 | 説明 |
|---|
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) |
Create bulk draft hires
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Rippling API key |
draftHires | json | はい | Array of draft hire objects |
| パラメータ | 型 | 説明 |
|---|
invalidItems | json | Failed draft hires |
successfulResults | json | Successful draft hires |
totalInvalid | number | Number of failures |
totalSuccessful | number | Number of successes |
