Rippling: List supergroup members — response body — results item

API reference · Contract 2026-10-28

SDK schema: List supergroup members — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
created_at	string	Required within parent	Record creation date
full_name	string	Optional	The group member’s full name.
id	string	Required within parent	Identifier field
updated_at	string	Required within parent	Record update date
work_email	string	Optional	The group member’s associated work email address.
worker	object	Optional	The worker associated with this group member. Expandable field
worker.business_partners	array	Optional	Worker’s assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners. Expandable field
worker.business_partners[]	Model	Each item	Expand Retrieve a specific worker — response body — business partners item
worker.business_partners_id	array	Optional	Worker’s assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.
worker.business_partners_id[]	string	Each item
worker.citizenship	string	Optional	The countries that the worker has citizenship in. 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
worker.compensation	Model	Optional	Expand Retrieve a specific worker — response body — compensation
worker.compensation_grade	object	Optional	The compensation grade assigned to the worker, if any.
worker.compensation_grade.id	string	Optional	The compensation grade’s unique identifier.
worker.compensation_grade.label	string	Optional	The compensation grade’s label.
worker.compensation_id	string	Optional	The compensation package for the worker.
worker.country	string	Optional	The worker’s country. 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
worker.country_fields	Model	Optional	Expand Retrieve a specific worker — response body — country fields
worker.created_at	string	Required within parent	Record creation date
worker.custom_fields	array	Optional	Custom field values defined on the Employee object for this worker Expandable field
worker.custom_fields[]	JSON	Each item	Additional keys: see wildcard field
worker.custom_fields[].*	JSON	Additional keys
worker.date_of_birth	string	Optional	The worker’s date of birth.
worker.department	Model	Optional	Expand Retrieve a specific worker — response body — department
worker.department_id	string	Optional	The worker’s assigned department.
worker.employment_type	Model	Optional	Expand Retrieve a specific worker — response body — employment type
worker.employment_type_id	string	Optional	The worker’s employment type.
worker.end_date	string	Optional	The end date of the worker.
worker.ethnicity	string	Optional	The identified ethnicity of the worker, if specified. Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY
worker.gender	string	Optional	The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY
worker.id	string	Required within parent	Identifier field
worker.is_manager	boolean	Optional	Whether the worker is a manager
worker.job_function	object	Optional	The worker’s job function. When expanded, this field requires `job-functions.read`. Expandable field
worker.job_function.created_at	string	Required within parent	Record creation date
worker.job_function.id	string	Required within parent	Identifier field
worker.job_function.name	string	Optional	Displayed name of the job function
worker.job_function.updated_at	string	Required within parent	Record update date
worker.job_function_id	string	Optional	ID of the worker’s job function.
worker.legal_entity	Model	Optional	Expand Retrieve a specific worker — response body — legal entity
worker.legal_entity_id	string	Optional	The worker’s associated legal entity.
worker.level	Model	Optional	Expand Retrieve a specific worker — response body — level
worker.level_id	string	Optional	The level of the worker.
worker.location	object	Optional	The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location’s type is remote.
worker.location.type	string	Required within parent	The type of location. Known values: REMOTE, WORK
worker.location.work_location_id	string	Required within parent	The work location, if the worker isn’t remote.
worker.manager	Model	Optional	Expand Retrieve a specific worker — response body — manager The worker’s manager. Expandable field
worker.manager_id	string	Optional	The worker’s manager.
worker.number	JSON	Optional
worker.number (anyOf 1)	integer	Alternative	The worker’s number within the organization.
worker.number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
worker.original_start_date	string	Optional	The worker’s earliest start date across their employment history, excluding INIT roles.
worker.overtime_exemption	string	Optional	The worker’s overtime exemption status. Known values: EXEMPT, NON_EXEMPT
worker.pay_schedule_id	string	Optional	The ID of the pay schedule currently associated with the worker.
worker.personal_email	string	Optional	The worker’s associated personal email address.
worker.race	string	Optional	The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER
worker.start_date	string	Optional	The start date of the worker.
worker.status	string	Optional	The worker’s status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED
worker.teams	array	Optional	The worker’s assigned teams. Expandable field
worker.teams[]	Model	Each item	Expand Update a team — response body — parent
worker.teams_id	array	Optional	The worker’s assigned teams.
worker.teams_id[]	string	Each item
worker.termination_details	object	Optional	The details of the worker’s termination, if applicable.
worker.termination_details.reason	string	Optional	This is a description that will be custom to each Rippling company.
worker.termination_details.type	string	Optional	The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE
worker.title	string	Optional	The worker’s title.
worker.title_effective_date	string	Optional	Title effective date
worker.updated_at	string	Required within parent	Record update date
worker.user	Model	Optional	Expand Retrieve a specific worker — response body — user
worker.user_id	string	Optional	The worker’s associated user.
worker.work_email	string	Optional	The worker’s associated work email address.
worker.work_schedule	object	Optional	The worker’s scheduled working hours for each day of the week. Additional keys: see wildcard field
worker.work_schedule.*	Model	Additional keys	Expand Retrieve a specific worker — response body — work schedule value
worker_id	string	Optional	The worker’s identifier associated with this group member.

Referenced models: Retrieve a specific worker — response body — business partners item, Update a team — response body — parent, Retrieve a specific worker — response body — work schedule value, Retrieve a specific worker — response body — manager, Retrieve a specific worker — response body — compensation, Retrieve a specific worker — response body — country fields, Retrieve a specific worker — response body — department, Retrieve a specific worker — response body — employment type, Retrieve a specific worker — response body — legal entity, Retrieve a specific worker — response body — level, Retrieve a specific worker — response body — user