Rippling: List devices
Rippling restApi.listDevices: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.list_devices
Provider route: GET /devices/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["listDevices"]>[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.listDevices(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.list_devices(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.filter | string | Optional | |
query.expand | string | Optional | |
query.order_by | string | Optional | |
query.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
Response
Section titled “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 | Model | Optional | Expand List Sites — response body — meta |
next_link | string | Optional | A link to the next page of responses. Format: uri |
results | array | Optional | |
results[] | Model | Each item | Expand List devices — response body — results item |
Referenced models: List devices — response body — results item, List Sites — response body — meta
Schemas
Section titled “Schemas”22 more schemas are linked from the tables above, on the schema pages.
List devices — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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, SOLD, 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 specific device — response body — worker
List Sites — response body — meta
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of redacted fields. |
redacted_fields | array | Optional | |
redacted_fields[] | object | Each item | |
redacted_fields[].name | string | Optional | The name for the redacted field |
redacted_fields[].reason | string | Optional | The reason for the redaction |
Retrieve a specific device — response body — pending actions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action_type | string | Optional | The 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_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
queued_at | string | Optional | When the action was queued. |
state | string | Optional | The current state of the pending action (e.g. QUEUED, WAITING_FOR_USER_ACTION). |
updated_at | string | Required within parent | Record update date |
Retrieve a specific worker — response body — business partners item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_partner_group | object | Optional | Business partner group the business partner is a part of Expandable field |
business_partner_group.created_at | string | Required within parent | Record creation date |
business_partner_group.default_business_partner | Model | Optional | Expand 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_id | string | Optional | Id 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.domain | string | Optional | Type of business partner group Known values: HR, IT, FINANCE, RECRUITING, OTHER |
business_partner_group.id | string | Required within parent | Identifier field |
business_partner_group.name | string | Required within parent | Name used to identify business partner group |
business_partner_group.updated_at | string | Required within parent | Record update date |
business_partner_group_id | string | Required within parent | Identifier of business partner group the business parter is a part of |
client_group | Model | Optional | Expand Create a new business partner — response body — client group |
client_group_id | string | Optional | Identifier of group of workers associated with the business partner |
client_group_member_count | JSON | Optional | |
client_group_member_count (anyOf 1) | integer | Alternative | Number of workers associated with the business partner |
client_group_member_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific worker — response body — manager Worker who is the business partner Expandable field |
worker_id | string | Required within parent | Identifier 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the team. |
parent | Model | Optional | Expand Update a team — response body — parent The parent team Expandable field |
parent_id | string | Optional | The parent team |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a team — response body — parent
Retrieve a specific worker — response body — work schedule value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scheduled working hours for a day of the week. |
hours | JSON | Optional | |
hours (anyOf 1) | number | Alternative | The number of scheduled working hours for the day. |
hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a specific worker — response body — country fields
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Country level fields for the worker. |
ca | object | Optional | Country-wise regional fields for Canada |
ca.sin | string | Optional | Social Insurance Number (SIN) for Canada employees. |
nz | object | Optional | Country-wise regional fields for New Zealand |
nz.ird_number | string | Optional | Inland Revenue Department (IRD) number for New Zealand employees. |
us | object | Optional | Country-wise regional fields for USA |
us.ssn | string | Optional | Social Security Number (SSN) for US employees. |
Retrieve a specific user — response body — emails item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display | string | Optional | The display value of the email address. |
type | string | Optional | The classification of the email. Known values: HOME, WORK, OTHER |
value | string | Optional | A valid email address. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.list_devices. Catalog operation: list-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"}