Rippling: Retrieve a specific user
Rippling restApi.getUsers: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.get_users
Provider route: GET /users/{id}/. 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"]["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 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.get_users(arguments) result = await call.wait() return result.body_json()| 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
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 | 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
Schemas
Section titled “Schemas”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. |
Retrieve a report run — response body — meta redacted fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Info about the redacted fields. |
name | string | Optional | The name for the redacted field |
reason | string | Optional | The reason for the redaction |
Retrieve a specific user — response body — addresses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Optional | The country component, pursuant to SCIM RFC 7643 4.1.2. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
formatted | string | Optional | The formatted mailing address. |
locality | string | Optional | The city or locality component. |
postal_code | string | Optional | The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2. |
region | string | Optional | The state or region component, pursuant to SCIM RFC 7643 4.1.2. |
street_address | string | Optional | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2.. |
type | string | Optional | The classification of the address. Known values: HOME, WORK, OTHER |
Retrieve a specific user — response body — phone numbers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display | string | Optional | The display value of the phone number. |
type | string | Optional | The classification of the phone number, pursuant to SCIM RFC 7643 4.1.2. Known values: HOME, WORK, MOBILE, FAX, OTHER |
value | string | Optional | The canonical global phone number pursuant to RFC3966. |
Retrieve a specific user — response body — photos item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | The classification of the photo. Known values: PHOTO, THUMBNAIL |
value | string | Optional | The URL of the photo. |
Retrieve a specific user — response body — name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The user's name. |
family_name | string | Optional | The legal family name of the user, or last name in most Western languages. |
formatted | string | Optional | The user's full name. |
given_name | string | Optional | The given legal name of the user, or first name in most Western languages. |
middle_name | string | Optional | The middle name(s) of the user. |
preferred_family_name | string | Optional | The preferred family name, or last name in most Western languages, by the user. |
preferred_given_name | string | Optional | The preferred given name, or first name in most Western languages, by the user. |
Policy, approvals and errors
Section titled “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"}