Skip to content

Rippling: Retrieve a specific worker — response body — user

Retrieve a specific worker: response body, field user. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Retrieve a specific worker — response body — user

FieldTypePresenceDescription and constraints
$objectRootThe worker’s associated user.

Expandable field
activebooleanOptionalWhether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.
addressesarrayOptionalThe user’s addresses.
addresses[]ModelEach itemExpand Retrieve a specific user — response body — addresses item
created_atstringRequired within parentRecord creation date
display_namestringOptionalThe display name of the user using either the concatenated preferred given and family name or username depending on availability.
emailsarrayOptionalThe user’s email addresses.
emails[]ModelEach itemExpand Retrieve a specific user — response body — emails item
idstringRequired within parentIdentifier field
localestringOptionalThe User’s default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.
nameModelOptionalExpand Retrieve a specific user — response body — name
numberstringOptionalThe permanent profile number of the user.
phone_numbersarrayOptionalThe user’s phone numbers.
phone_numbers[]ModelEach itemExpand Retrieve a specific user — response body — phone numbers item
photosarrayOptionalThe user’s photos.
photos[]ModelEach itemExpand Retrieve a specific user — response body — photos item
preferred_languagestringOptionalThe 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.
timezonestringOptionalThe User’s current time zone in IANA database Olson format
updated_atstringRequired within parentRecord update date
usernamestringOptionalThe 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 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.