Rippling: Retrieve a specific device

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.get_devices

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

Call through Alter

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()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Format: id
query	object	Optional	Additional keys: not allowed
query.expand	string	Optional

Response

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

Field	Type	Presence	Description and constraints
$	object	Root
__meta	object	Optional
__meta.redacted_fields	array	Optional
__meta.redacted_fields[]	Model	Each item	Expand Retrieve a report run — response body — meta redacted fields item
created_at	string	Required within parent	Record creation date
enrollment_status	string	Optional	The MDM enrollment status: ENROLLED, UNENROLLED, WAITING_FOR_CONNECTION, ERROR, etc. Known values: ENROLLED, WAITING_FOR_CONNECTION, ERROR, UNENROLLED
id	string	Required within parent	Identifier field
is_encrypted	boolean	Optional	Whether the device’s disk is encrypted (FileVault on macOS, BitLocker on Windows).
is_managed	boolean	Optional	Whether the device is managed via MDM.
last_checkin_at	string	Optional	When the Rippling agent last checked in from this device.
last_mdm_sync_at	string	Optional	When the device last synced with MDM.
lifecycle_state	string	Optional	The 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, MDM_LOCKED, LOST, LOST_PLAYING_SOUND
mdm_provider	string	Optional	The 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
model	string	Optional	The device hardware model identifier as reported by MDM (e.g. ‘MacBookPro18,3’, ‘iPhone15,2’).
os_name	string	Optional	The device operating system name.
os_version	string	Optional	The device operating system version.
pending_actions	array	Optional	Actions currently queued against the device (not yet completed). Expandable. Expandable field
pending_actions[]	Model	Each item	Expand Retrieve a specific device — response body — pending actions item
pending_actions_id	array	Optional	The IDs of actions currently queued against the device (not yet completed).
pending_actions_id[]	string	Each item
platform	string	Optional	The OS platform the device runs: MACOS, WINDOWS, IOS, or IPADOS. Known values: MACOS, WINDOWS, IOS, IPADOS
serial_number	string	Optional	The device’s hardware serial number.
updated_at	string	Required within parent	Record update date
worker	Model	Optional	Expand Retrieve a specific device — response body — worker
worker_id	string	Optional	The 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

Policy, approvals and errors

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