Skip to content

Rippling: Retrieve a specific device

Rippling restApi.getDevices: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.get_devices

Provider route: GET /devices/{id}/. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["getDevices"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.restApi.getDevices(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.rest_api.get_devices(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parentFormat: id
queryobjectOptionalAdditional keys: not allowed
query.expandstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
__metaobjectOptional
__meta.redacted_fieldsarrayOptional
__meta.redacted_fields[]ModelEach itemExpand Retrieve a report run — response body — meta redacted fields item
created_atstringRequired within parentRecord creation date
enrollment_statusstringOptionalThe MDM enrollment status: ENROLLED, UNENROLLED, WAITING_FOR_CONNECTION, ERROR, etc.
Known values: ENROLLED, WAITING_FOR_CONNECTION, ERROR, UNENROLLED
idstringRequired within parentIdentifier field
is_encryptedbooleanOptionalWhether the device’s disk is encrypted (FileVault on macOS, BitLocker on Windows).
is_managedbooleanOptionalWhether the device is managed via MDM.
last_checkin_atstringOptionalWhen the Rippling agent last checked in from this device.
last_mdm_sync_atstringOptionalWhen the device last synced with MDM.
lifecycle_statestringOptionalThe device lifecycle state (e.g. ACTIVE, READY, LOCKED, LOST, DECOMMISSIONED).
Known values: INIT, ACTIVE, ACTIVATING, LOCKED, LOCKING, INACTIVE, PENDING_MDM, CLEANING, READY, DECOMMISSIONING, DECOMMISSIONED, FULL_WIPING, FULL_WIPED, E_CYCLED, SOLD, MDM_LOCKED, LOST, LOST_PLAYING_SOUND
mdm_providerstringOptionalThe MDM provider currently recorded on the device (RIPPLING, JAMFCLOUD, INTUNE, KANDJI, etc.). Null when the device is not currently MDM-managed (typical for unenrolled or recently-reset devices).
Known values: RIPPLING, JUMPCLOUD, JAMFCLOUD, FLEETSMITH, HEXNODE, MICROMDM, MERAKI, SOTI, ADDIGY, FLEETDM, KANDJI, ZOHO, INTUNE, OTHER
modelstringOptionalThe device hardware model identifier as reported by MDM (e.g. ‘MacBookPro18,3’, ‘iPhone15,2’).
os_namestringOptionalThe device operating system name.
os_versionstringOptionalThe device operating system version.
pending_actionsarrayOptionalActions currently queued against the device (not yet completed). Expandable.

Expandable field
pending_actions[]ModelEach itemExpand Retrieve a specific device — response body — pending actions item
pending_actions_idarrayOptionalThe IDs of actions currently queued against the device (not yet completed).
pending_actions_id[]stringEach item
platformstringOptionalThe OS platform the device runs: MACOS, WINDOWS, IOS, or IPADOS.
Known values: MACOS, WINDOWS, IOS, IPADOS
serial_numberstringOptionalThe device’s hardware serial number.
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific device — response body — worker
worker_idstringOptionalThe ID of the worker this device is currently assigned to. Null if unassigned.

Referenced models: Retrieve a specific device — response body — pending actions item, Retrieve a report run — response body — meta redacted fields item, Retrieve a specific device — response body — worker

20 more schemas are linked from the tables above, on the schema pages.

Retrieve a specific device — response body — pending actions item
FieldTypePresenceDescription and constraints
$objectRoot
action_typestringOptionalThe type of the pending device action (e.g. LOCK_DEVICE, RESET_PASSWORD).
Known values: ADD_USER_TO_FILEVAULT, ASSIGN_DEVICE, AUTHENTICATE_AGENT, CHANGE_FILEVAULT_RECOVERY_KEY, CHANGE_PASSWORD, CLEAR_PASSCODE, CREATE_RIPPLING_ADMIN, DELETE_LOCAL_ACCOUNT, DEMOTE_ACCOUNT_PERMISSION, DISABLE_FIND_MY, DISABLE_LOST_MODE, DISABLE_REMOTE_DESKTOP, ENABLE_LOST_MODE, ENABLE_REMOTE_DESKTOP, ENFORCE_PASSWORD_POLICY, FORCE_CHECK_IN, FULL_WIPE, GRANT_SECURE_TOKEN, INSTALL_ENROLLMENT_PROFILE, LOCK_DEVICE, LOCK_USER_ACCOUNT, LOST_MODE_GET_LOCATION, LOST_MODE_PLAY_SOUND, PROMOTE_ACCOUNT_PERMISSION, RECOVER_AGENT_VIA_MDM, REINSTALL_AGENT, REINSTALL_ENROLLMENT_PROFILE, REMOVE_OTHER_ENROLLMENT_PROFILES, RESET_PASSWORD, RESTART_DEVICE, ROTATE_FILEVAULT_KEY, SHUTDOWN_DEVICE, SOFT_WIPE, TURN_ON_FILEVAULT, UNASSIGN_DEVICE, UNINSTALL_AGENT, UNINSTALL_ANTIVIRUS, UNINSTALL_MDM, UNLOCK_DEVICE, UNLOCK_USER_ACCOUNT, UPDATE_OS, UNKNOWN
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
queued_atstringOptionalWhen the action was queued.
statestringOptionalThe current state of the pending action (e.g. QUEUED, WAITING_FOR_USER_ACTION).
updated_atstringRequired within parentRecord update date
Retrieve a report run — response body — meta redacted fields item
FieldTypePresenceDescription and constraints
$objectRootInfo about the redacted fields.
namestringOptionalThe name for the redacted field
reasonstringOptionalThe reason for the redaction
Retrieve a specific worker — response body — business partners item
FieldTypePresenceDescription and constraints
$objectRoot
business_partner_groupobjectOptionalBusiness partner group the business partner is a part of

Expandable field
business_partner_group.created_atstringRequired within parentRecord creation date
business_partner_group.default_business_partnerModelOptionalExpand Retrieve a specific worker — response body — manager
Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.

Expandable field
business_partner_group.default_business_partner_idstringOptionalId of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.
business_partner_group.domainstringOptionalType of business partner group
Known values: HR, IT, FINANCE, RECRUITING, OTHER
business_partner_group.idstringRequired within parentIdentifier field
business_partner_group.namestringRequired within parentName used to identify business partner group
business_partner_group.updated_atstringRequired within parentRecord update date
business_partner_group_idstringRequired within parentIdentifier of business partner group the business parter is a part of
client_groupModelOptionalExpand Create a new business partner — response body — client group
client_group_idstringOptionalIdentifier of group of workers associated with the business partner
client_group_member_countJSONOptional
client_group_member_count (anyOf 1)integerAlternativeNumber of workers associated with the business partner
client_group_member_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific worker — response body — manager
Worker who is the business partner

Expandable field
worker_idstringRequired within parentIdentifier of worker who is the business partner

Referenced models: Retrieve a specific worker — response body — manager, Create a new business partner — response body — client group

Update a team — response body — parent
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the team.
parentModelOptionalExpand Update a team — response body — parent
The parent team

Expandable field
parent_idstringOptionalThe parent team
updated_atstringRequired within parentRecord update date

Referenced models: Update a team — response body — parent

Retrieve a specific worker — response body — work schedule value
FieldTypePresenceDescription and constraints
$objectRootThe scheduled working hours for a day of the week.
hoursJSONOptional
hours (anyOf 1)numberAlternativeThe number of scheduled working hours for the day.
hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve a specific worker — response body — country fields
FieldTypePresenceDescription and constraints
$objectRootCountry level fields for the worker.
caobjectOptionalCountry-wise regional fields for Canada
ca.sinstringOptionalSocial Insurance Number (SIN) for Canada employees.
nzobjectOptionalCountry-wise regional fields for New Zealand
nz.ird_numberstringOptionalInland Revenue Department (IRD) number for New Zealand employees.
usobjectOptionalCountry-wise regional fields for USA
us.ssnstringOptionalSocial Security Number (SSN) for US employees.
Retrieve a specific worker — response body — department
FieldTypePresenceDescription and constraints
$objectRootThe worker's assigned department.

Expandable field
created_atstringRequired within parentRecord creation date
department_hierarchyarrayOptionalList of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.

Expandable field
department_hierarchy[]ModelEach itemExpand Update a department — response body — parent
department_hierarchy_idarrayOptionalThe identifier of departments in the department hierarchy ordered from parent department to child department.
department_hierarchy_id[]stringEach item
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the department.
parentModelOptionalExpand Update a department — response body — parent
The parent department.

Expandable field
parent_idstringOptionalThe parent department.
reference_codestringOptionalReference code of the department.
updated_atstringRequired within parentRecord update date

Referenced models: Update a department — response body — parent

Retrieve a specific worker — response body — employment type
FieldTypePresenceDescription and constraints
$objectRootThe worker's employment type.

Expandable field
amount_workedstringOptionalThe amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.
Known values: PART-TIME, FULL-TIME, TEMPORARY
compensation_time_periodstringOptionalThe compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.
Known values: HOURLY, SALARIED
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
labelstringRequired within parentThe display label of the employment type.
namestringOptionalThe name of the employment type for non-custom employment types.
typestringOptionalThe classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.
Known values: CONTRACTOR, EMPLOYEE
updated_atstringRequired within parentRecord update date
Retrieve a specific user — response body — emails item
FieldTypePresenceDescription and constraints
$objectRoot
displaystringOptionalThe display value of the email address.
typestringOptionalThe classification of the email.
Known values: HOME, WORK, OTHER
valuestringOptionalA valid email address.

SDK function policy ID: rippling.rest_api.get_devices. Catalog operation: get-devices. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["devices.read"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.