Rippling — единая платформа управления персоналом, объединяющая HR, IT и финансы в одну систему. Rippling позволяет компаниям управлять начислением зарплаты, льготами, устройствами, приложениями и многим другим — из одного места, — автоматизируя рутинную ручную работу, которая обычно отнимает много времени у HR-команд. Платформенный REST API даёт программный доступ к сотрудникам, пользователям, отделам, командам, кастомным объектам, бизнес-партнёрам, супергруппам и многому другому.
Почему Rippling?
- Полные данные о персонале: доступ к сотрудникам, пользователям, компаниям, правам, отделам, командам, должностям, типам занятости, функциональным ролям, рабочим локациям и кастомным полям — полный организационный граф в одном API.
- Платформа кастомных объектов: создавайте, управляйте и опрашивайте кастомные объекты с типизированными полями, записями и массовыми операциями — расширяйте модель данных Rippling под нужды вашего бизнеса.
- Управление бизнес-партнёрами: отслеживайте вендоров, подрядчиков и внешних партнёров с полным CRUD-набором операций и группировкой через группы бизнес-партнёров.
- Контроль доступа через супергруппы: управляйте динамическими группами прав с гранулярными списками включения и исключения участников.
- Расширяемость платформы: создавайте кастомные приложения, страницы, настройки и категории объектов, которые нативно встроены в интерфейс Rippling.
- Автоматизированная отчётность: запускайте отчёты программно и опрашивайте результаты, чтобы строить полностью автоматизированные пайплайны отчётности.
Использование Rippling в AACFlow
Интеграция Rippling в AACFlow подключает ваши воркфлоу напрямую к аккаунту Rippling через API-ключ. С 86 операциями, охватывающими сотрудников, пользователей, отделы, команды, должности, рабочие локации, бизнес-партнёров, супергруппы, кастомные объекты, кастомные приложения, страницы, настройки, категории объектов, отчёты и черновики найма, вы можете строить мощные HR- и платформенные автоматизации без написания backend-кода.
Ключевые преимущества использования Rippling в AACFlow:
- Управление сотрудниками и пользователями: получайте, ищите и просматривайте данные сотрудников и пользователей для чек-листов онбординга, воркфлоу offboarding и обновлений организационной структуры.
- Организационная аналитика: запрашивайте отделы, команды, должности, типы занятости, функциональные роли, рабочие локации и кастомные поля для построения динамичных отчётов или запуска действий на основе структурных изменений.
- Автоматизация кастомных объектов: создавайте кастомные объекты, определяйте поля и управляйте записями — включая массовые операции создания, обновления и удаления — расширяя модель данных Rippling под ваши воркфлоу.
- Воркфлоу по бизнес-партнёрам: управляйте вендорами и внешними партнёрами с полным набором операций жизненного цикла, включая группировку и категоризацию.
- Разработка приложений на платформе: создавайте и управляйте кастомными приложениями, страницами, настройками и категориями объектов, расширяющими нативный функционал Rippling.
- Автоматизация отчётов: запускайте отчёты и опрашивайте результаты, выстраивая автоматизированные пайплайны отчётности без ручных действий.
- Черновики найма: одной операцией передавайте в onboarding-поток Rippling один или несколько черновиков найма со всеми необходимыми данными сотрудника.
Автоматизируете ли вы онбординг новых сотрудников, управляете данными кастомных объектов, строите организационные отчёты или расширяете платформу Rippling кастомными приложениями — Rippling в AACFlow даёт прямой и безопасный доступ ко всему платформенному REST API Rippling без посредников. Просто настройте API-ключ, выберите нужную операцию — а AACFlow позаботится об остальном.
Интегрируйте Rippling Platform в ваш рабочий процесс. Управлять workers, users, departments, teams, titles, work locations, business partners, supergroups, custom objects, custom apps, custom pages, custom settings, object categories, reports, и draft hires.
Список всех workers с optional фильтрация и постраничная выборка
| Параметр | Тип | Обязательный | Описание |
|---|
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 | Произошла ли 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 | Массив 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 | Массив 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 |
Получить a specific worker от 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 |
Список всех users с optional постраничная выборка
| Параметр | Тип | Обязательный | Описание |
|---|
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 | Произошла ли 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 | Массив email objects |
↳ phone_numbers | json | Массив phone number objects |
↳ addresses | json | Массив address objects |
↳ photos | json | Массив photo objects |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
Получить a specific user от 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 |
Список всех 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 | Массив 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 |
Получить SSO information для 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 |
Список всех 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 |
Список всех 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 | Массив 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 |
Получить a specific department от 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 | Массив department IDs in hierarchy |
parent | json | Expanded parent department |
department_hierarchy | json | Expanded department hierarchy |
__meta | json | Metadata including redacted_fields |
Создать новый 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 |
Обновитьn 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 |
Список всех 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 |
Получить a specific team от 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 |
Список всех 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 |
Получить a specific employment type от 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 |
Список всех 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 |
Получить a specific title от 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 |
Создать новый 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 |
Обновитьn 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 |
Удалить title
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
id | string | Да | ID of the resource to delete |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли resource was deleted |
Список всех 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 | Произошла ли 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 |
Список всех 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 |
Получить a specific job function от 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 |
Список всех 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 |
Получить a specific work location от 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 |
Создать новый 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 |
Обновить 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 |
Удалить work location
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
id | string | Да | ID of the resource to delete |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли resource was deleted |
Список всех 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 |
Получить a specific business partner от 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 |
Создать новый 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 |
Удалить business partner
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
id | string | Да | ID of the resource to delete |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли resource was deleted |
Список всех 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 |
Получить a specific business partner group от 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 |
Создать новый 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 |
Удалить business partner group
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
id | string | Да | ID of the resource to delete |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли resource was deleted |
Список всех 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 | Произошла ли group is read only |
↳ parent | string | Parent group ID |
↳ mutually_exclusive_key | string | Mutually exclusive key |
↳ cumulatively_exhaustive_default | boolean | Произошла ли group is the cumulatively exhaustive default |
↳ include_terminated | boolean | Произошла ли group includes terminated roles |
↳ allow_non_employees | boolean | Произошла ли group allows non-employees |
↳ can_override_role_states | boolean | Произошла ли group can override role states |
↳ priority | number | Group priority |
↳ is_invisible | boolean | Произошла ли 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 |
Получить a specific supergroup от 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 | Произошла ли group is read only |
parent | string | Parent group ID |
mutually_exclusive_key | string | Mutually exclusive key |
cumulatively_exhaustive_default | boolean | Произошла ли group is the cumulatively exhaustive default |
include_terminated | boolean | Произошла ли group includes terminated roles |
allow_non_employees | boolean | Произошла ли group allows non-employees |
can_override_role_states | boolean | Произошла ли group can override role states |
priority | number | Group priority |
is_invisible | boolean | Произошла ли group is invisible |
ignore_prov_group_matching | boolean | Whether to ignore provisioning group matching |
__meta | json | Metadata including redacted_fields |
Список 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 |
Список 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 |
Список 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 |
Обновить 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 | Произошла ли operation succeeded |
Обновить 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 | Произошла ли operation succeeded |
Список всех 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 |
Получить a custom object от 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 |
Создать новый 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 |
Обновить 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 |
Удалить custom object
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
customObjectApiName | string | Да | ID of the resource to delete |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли resource was deleted |
Список всех fields для 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 | Произошла ли field is unique |
↳ is_immutable | boolean | Произошла ли field is immutable |
↳ is_standard | boolean | Произошла ли 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 |
Получить 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 |
Создать 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 | Нет | Произошла ли 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 |
Обновить 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 | Нет | Произошла ли 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 |
Удалить field from a custom object
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
customObjectApiName | string | Да | Custom object API name |
fieldApiName | string | Да | Field API name |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли field was deleted |
Список всех records для 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 |
Получить 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 |
Получить 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 |
Запрос custom object records с 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 |
Создать 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 |
Обновить 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 |
Удалить custom object record
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
customObjectApiName | string | Да | Custom object API name |
codrId | string | Да | Record ID |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли record was deleted |
Bulk create custom object records
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
customObjectApiName | string | Да | Custom object API name |
rowsToWrite | json | Да | Массив 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 | Да | Массив 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 | Да | Массив records to delete |
allOrNothing | boolean | Нет | If true, fail entire batch on any error |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли bulk delete succeeded |
Список всех 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 | Массив page summaries |
totalCount | number | Number of items returned |
nextLink | string | Link to next page of results |
__meta | json | Metadata including redacted_fields |
Получить 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 | Массив page summaries |
__meta | json | Metadata including redacted_fields |
Создать новый 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 | Массив page summaries |
Обновить 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 | Массив page summaries |
Удалить custom app
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
id | string | Да | ID of the resource to delete |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли resource was deleted |
Список всех 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 |
Получить 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 |
Создать новый 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 |
Обновить 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 |
Удалить custom page
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
id | string | Да | ID of the resource to delete |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли resource was deleted |
Список всех 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 |
Получить 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 |
Создать новый 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 |
Обновить 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 |
Удалить custom setting
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
id | string | Да | ID of the resource to delete |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли resource was deleted |
Список всех 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 |
Получить 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 |
Создать новый 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 |
Обновитьn 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 |
Удалитьn object category
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
id | string | Да | ID of the resource to delete |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли resource was deleted |
Получить a report run от 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) |
Создать bulk draft hires
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Rippling API key |
draftHires | json | Да | Массив draft hire objects |
| Параметр | Тип | Описание |
|---|
invalidItems | json | Failed draft hires |
successfulResults | json | Successful draft hires |
totalInvalid | number | Number of failures |
totalSuccessful | number | Number of successes |
