Rippling: Retrieve a specific user

← rest_api operations · Get started · OpenAPI downloads

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

Provider route: GET /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"]["getUsers"]>[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.getUsers(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_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

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
active	boolean	Optional	Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.
addresses	array	Optional	The user’s addresses.
addresses[]	Model	Each item	Expand Retrieve a specific user — response body — addresses item
created_at	string	Required within parent	Record creation date
display_name	string	Optional	The display name of the user using either the concatenated preferred given and family name or username depending on availability.
emails	array	Optional	The user’s email addresses.
emails[]	Model	Each item	Expand Retrieve a specific user — response body — emails item
id	string	Required within parent	Identifier field
locale	string	Optional	The User’s default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.
name	Model	Optional	Expand Retrieve a specific user — response body — name
number	string	Optional	The permanent profile number of the user.
phone_numbers	array	Optional	The user’s phone numbers.
phone_numbers[]	Model	Each item	Expand Retrieve a specific user — response body — phone numbers item
photos	array	Optional	The user’s photos.
photos[]	Model	Each item	Expand Retrieve a specific user — response body — photos item
preferred_language	string	Optional	The User’s preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.
timezone	string	Optional	The User’s current time zone in IANA database Olson format
updated_at	string	Required within parent	Record update date
username	string	Optional	The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.

Referenced models: Retrieve a specific user — response body — emails item, Retrieve a report run — response body — meta redacted fields item, Retrieve a specific user — response body — addresses item, Retrieve a specific user — response body — phone numbers item, Retrieve a specific user — response body — photos item, Retrieve a specific user — response body — name

Policy, approvals and errors

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

Provider entitlements: ["API_Tier_1"]

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

Official provider source