Rippling
App · 25 actions
Read workers, users, organization structure, compensation and leave data from Rippling’s REST API.
Actions
| Action | What it does |
|---|---|
| Get compensation | Read one compensations. |
| Get department | Read one departments. |
| Get employment type | Read one employment types. |
| Get job function | Read one job functions. |
| Get leave request | Read one leave requests. |
| Get legal entity | Read one legal entities. |
| Get level | Read one levels. |
| Get team | Read one teams. |
| Get user | Read one users. |
| Get work location | Read one work locations. |
| Get worker | Read one workers. |
| List companies | Read companies available to this token, including the connected company. |
| List compensations | List a page of compensations. |
| List custom fields | List a page of custom fields. |
| List departments | List a page of departments. |
| List employment types | List a page of employment types. |
| List entitlements | List a page of entitlements. |
| List job functions | List a page of job functions. |
| List leave requests | List a page of leave requests. |
| List legal entities | List a page of legal entities. |
| List levels | List a page of levels. |
| List teams | List a page of teams. |
| List users | List a page of users. |
| List work locations | List a page of work locations. |
| List workers | List a page of workers. |
Get compensation
Read one compensations. Access follows the token owner’s permissions and scopes.
Inputs
- Compensation ID
idtextRequired - Id.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
worker.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
}
}
}Get department
Read one departments. Access follows the token owner’s permissions and scopes.
Inputs
- Department
idtextRequired - Id.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
parent,department_hierarchy(Department hierarchy).
Outputs
dataobject- Response.
Example output
{
"data": {
"created_at": "example",
"department_hierarchy": [],
"department_hierarchy_id": [],
"id": "example",
"name": "example",
"parent": {
"created_at": "example",
"department_hierarchy": [],
"department_hierarchy_id": [],
"id": "example",
"name": "example",
"parent": {
"created_at": "example",
"department_hierarchy": [],
"department_hierarchy_id": [],
"id": "example",
"name": "example",
"parent": {
"created_at": "example",
"department_hierarchy": [],
"department_hierarchy_id": [],
"id": "example",
"name": "example",
"parent": {},
"parent_id": "example",
"reference_code": "example",
"updated_at": "example"
},
"parent_id": "example",
"reference_code": "example",
"updated_at": "example"
},
"parent_id": "example",
"reference_code": "example",
"updated_at": "example"
},
"parent_id": "example",
"reference_code": "example",
"updated_at": "example"
}
}Get employment type
Read one employment types. Access follows the token owner’s permissions and scopes.
Inputs
- Employment type
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
}
}
}Get job function
Read one job functions. Access follows the token owner’s permissions and scopes.
Inputs
- Job function ID
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
}
}
}Get leave request
Read one leave requests. Access follows the token owner’s permissions and scopes.
Inputs
- Leave request ID
idtextRequired - Id.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
worker,requester,leave_type(Leave type),reviewer.
Outputs
dataobject- Response.
Example output
{
"data": {
"comments": "example",
"created_at": "example",
"days_take_off": [],
"end_date": "example",
"end_time": "example",
"id": "example",
"is_managed_by_external_system": false,
"leave_event_id": "example",
"leave_policy_id": "example",
"leave_type": {
"created_at": "example",
"id": "example",
"is_managed_by_external_system": false,
"is_paid": false,
"name": "example",
"type": "example",
"updated_at": "example"
},
"leave_type_id": "example",
"number_of_minutes_requested": 1,
"reason_for_leave": "example",
"requester": {
"created_at": "example",
"id": "example",
"updated_at": "example"
},
"requester_id": "example",
"reviewed_at": "example",
"reviewer": {
"business_partners": [],
"business_partners_id": [],
"citizenship": "example",
"compensation": {
"created_at": "example",
"id": "example",
"updated_at": "example"
},
"compensation_grade": {
"id": "example",
"label": "example"
},
"compensation_id": "example",
"country": "example",
"country_fields": {
"ca": {
"sin": "example"
},
"nz": {
"ird_number": "example"
},
"us": {
"ssn": "example"
}
},
"created_at": "example",
"custom_fields": [],
"date_of_birth": "example",
"department": {
"created_at": "example",
"id": "example",
"name": "example",
"updated_at": "example"
},
"department_id": "example",
"employment_type": {
"created_at": "example",
"id": "example",
"label": "example",
"updated_at": "example"
},
"employment_type_id": "example",
"end_date": "example",
"ethnicity": "example",
"gender": "example",
"id": "example",
"is_manager": false,
"job_function": {
"created_at": "example",
"id": "example",
"name": "example",
"updated_at": "example"
},
"job_function_id": "example",
"legal_entity": {
"created_at": "example",
"id": "example",
"updated_at": "example"
},
"legal_entity_id": "example",
"level": {
"created_at": "example",
"id": "example",
"name": "example",
"parent_id": "example",
"updated_at": "example"
},
"level_id": "example",
"location": {
"type": "example",
"work_location_id": "example"
},
"manager": {
"created_at": "example",
"id": "example",
"updated_at": "example"
},
"manager_id": "example",
"number": 1,
"original_start_date": "example",
"overtime_exemption": "example",
"pay_schedule_id": "example",
"personal_email": "example",
"race": "example",
"start_date": "example",
"status": "example",
"teams": [],
"teams_id": [],
"termination_details": {
"reason": "example",
"type": "example"
},
"title": "example",
"title_effective_date": "example",
"updated_at": "example",
"user": {
"created_at": "example",
"id": "example",
"updated_at": "example"
},
"user_id": "example",
"work_email": "example",
"work_schedule": {}
},
"reviewer_id": "example",
"start_date": "example",
"start_time": "example",
"status": "example",
"updated_at": "example",
"worker": {
"created_at": "example",
"id": "example",
"updated_at": "example"
},
"worker_id": "example"
}
}Get legal entity
Read one legal entities. Access follows the token owner’s permissions and scopes.
Inputs
- Legal entity
idtextRequired - Id.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
parent,company.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
}
}
}Get level
Read one levels. Access follows the token owner’s permissions and scopes.
Inputs
- Level
idtextRequired - Id.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
parent,track.
Outputs
dataobject- Response.
Example output
{
"data": {
"created_at": "example",
"description": "example",
"experience_requirements": "example",
"global_level": 1,
"id": "example",
"name": "example",
"parent": {
"created_at": "example",
"description": "example",
"experience_requirements": "example",
"global_level": 1,
"id": "example",
"name": "example",
"parent": {
"created_at": "example",
"description": "example",
"experience_requirements": "example",
"global_level": 1,
"id": "example",
"name": "example",
"parent": {
"created_at": "example",
"description": "example",
"experience_requirements": "example",
"global_level": "example",
"id": "example",
"name": "example",
"parent": {},
"parent_id": "example",
"rank": "example",
"scope_of_responsibilities": "example",
"track": {},
"track_id": "example",
"updated_at": "example"
},
"parent_id": "example",
"rank": 1,
"scope_of_responsibilities": "example",
"track": {
"created_at": "example",
"id": "example",
"is_default": "example",
"name": "example",
"order": "example",
"start_global_level": "example",
"updated_at": "example"
},
"track_id": "example",
"updated_at": "example"
},
"parent_id": "example",
"rank": 1,
"scope_of_responsibilities": "example",
"track": {
"created_at": "example",
"id": "example",
"is_default": false,
"name": "example",
"order": 1,
"start_global_level": 1,
"updated_at": "example"
},
"track_id": "example",
"updated_at": "example"
},
"parent_id": "example",
"rank": 1,
"scope_of_responsibilities": "example",
"track": {
"created_at": "example",
"id": "example",
"is_default": false,
"name": "example",
"order": 1,
"start_global_level": 1,
"updated_at": "example"
},
"track_id": "example",
"updated_at": "example"
}
}Get team
Read one teams. Access follows the token owner’s permissions and scopes.
Inputs
- Team
idtextRequired - Id.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
parent.
Outputs
dataobject- Response.
Example output
{
"data": {
"created_at": "example",
"id": "example",
"name": "example",
"parent": {
"created_at": "example",
"id": "example",
"name": "example",
"parent": {
"created_at": "example",
"id": "example",
"name": "example",
"parent": {
"created_at": "example",
"id": "example",
"name": "example",
"parent": {},
"parent_id": "example",
"updated_at": "example"
},
"parent_id": "example",
"updated_at": "example"
},
"parent_id": "example",
"updated_at": "example"
},
"parent_id": "example",
"updated_at": "example"
}
}Get user
Read one users. Access follows the token owner’s permissions and scopes.
Inputs
- User
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
}
}
}Get work location
Read one work locations. Access follows the token owner’s permissions and scopes.
Inputs
- Work location
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"address": {
"country": "example",
"formatted": "example",
"locality": "example",
"postal_code": "example",
"region": "example",
"street_address": "example",
"type": "example"
},
"created_at": "example",
"id": "example",
"name": "example",
"updated_at": "example"
}
}Get worker
Read one workers. Access follows the token owner’s permissions and scopes.
Inputs
- Worker
idtextRequired - Id.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
user,manager,legal_entity(Legal entity),employment_type(Employment type),compensation,department,teams,level,job_function(Job function),custom_fields(Custom fields),business_partners(Business partners).
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
}
}
}List companies
Read companies available to this token, including the connected company.
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Cursor
cursortext - Cursor.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
parent_legal_entity(Parent legal entity),legal_entities(Legal entities). - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List compensations
List a page of compensations. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
worker. - Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List custom fields
List a page of custom fields. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List departments
List a page of departments. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
parent,department_hierarchy(Department hierarchy). - Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List employment types
List a page of employment types. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List entitlements
List a page of entitlements. Access follows the token owner’s permissions and scopes.
Inputs
None.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List job functions
List a page of job functions. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List leave requests
List a page of leave requests. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
worker,requester,leave_type(Leave type),reviewer. - Filter
filtertext - Filter.
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {},
"next_link": "example",
"results": []
}
}List legal entities
List a page of legal entities. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
parent,company. - Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List levels
List a page of levels. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
parent,track. - Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List teams
List a page of teams. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
parent. - Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List users
List a page of users. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List work locations
List a page of work locations. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {
"redacted_fields": []
},
"next_link": "example",
"results": []
}
}List workers
List a page of workers. Access follows the token owner’s permissions and scopes.
Inputs
- Cursor
cursortext - Cursor.
- Expand
expandlist - Related records to include. The token needs read access to each selection.One or more of:
user,manager,legal_entity(Legal entity),employment_type(Employment type),compensation,department,teams,level,job_function(Job function),custom_fields(Custom fields),business_partners(Business partners). - Filter
filtertext - Filter.
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - Order by
order_bytext - Order by.
Outputs
dataobject- Response.
Example output
{
"data": {
"__meta": {},
"next_link": "example",
"results": []
}
}