Rippling: Retrieve a specific app user

← rest_api operations · Get started · OpenAPI downloads

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

Provider route: GET /app-users/{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"]["getAppUsers"]>[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.getAppUsers(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_app_users(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
app_display_name	string	Optional	Human-readable display name for the third-party app (e.g. ‘Slack’, ‘GitHub’). Sourced from the customer-configured SpokeOwner.app_display_name; falls back to a title-cased app handle when the customer hasn’t set one.
app_handle	string	Optional	Machine-readable identifier for the third-party app (e.g. ‘slack’, ‘jira’, ‘asana’). Stable across the App Shop catalog.
created_at	string	Required within parent	Record creation date
external_email	string	Optional	The user’s email address in the third-party app, if known. Null when the app does not expose an email or Rippling did not capture one.
external_username	string	Optional	The user’s display name in the third-party app, if known. Null when the app does not surface a separate username.
id	string	Required within parent	Identifier field
match_state	string	Optional	Whether this third-party account has been matched to a Rippling worker. Known values: MATCHED, NOT_MATCHED, IGNORED
push_state	string	Optional	Provisioning lifecycle state of this account in the third-party app. Known values: INIT, EMPLOYEE_CONFIRMATION_PENDING, EMPLOYEE_CONFIRMATION_ACCEPTED, EMPLOYEE_CONFIRMATION_REJECTED, INVITE_PENDING, INVITE_CONFIRMED, INVITE_FAILED, CREATE_PENDING, CREATE_CONFIRMED, CREATE_FAILED, DELETE_PENDING, DELETE_CONFIRMED, DELETE_FAILED, SUSPEND_PENDING, SUSPEND_CONFIRMED, SUSPEND_FAILED
spoke_user_identifier	string	Optional	Identifier for the user’s account in the third-party app workspace. Depending on the integration, this may be an email, username, account handle, or app-specific user id.
updated_at	string	Required within parent	Record update date
worker	Model	Optional	Expand Retrieve a specific app user — response body — worker
worker_id	string	Optional	ID of the Rippling worker associated with this external app account.

Referenced models: Retrieve a report run — response body — meta redacted fields item, Retrieve a specific app user — response body — worker

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.get_app_users. Catalog operation: get-app-users. 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: ["app-users.read"]

Provider entitlements: ["API_Tier_1"]

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

Official provider source