Skip to content

Rippling: List business partners — response body — results item

List business partners: response body, field results / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: List business partners — response body — results item

FieldTypePresenceDescription and constraints
$objectRoot
business_partner_groupModelOptionalExpand Create a new business partner — response body — business partner group
business_partner_group_idstringRequired within parentIdentifier of business partner group the business parter is a part of
client_groupModelOptionalExpand Create a new business partner — response body — client group
client_group_idstringOptionalIdentifier of group of workers associated with the business partner
client_group_member_countJSONOptional
client_group_member_count (anyOf 1)integerAlternativeNumber of workers associated with the business partner
client_group_member_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Create a new business partner — response body — worker
worker_idstringRequired within parentIdentifier of worker who is the business partner

Referenced models: Create a new business partner — response body — business partner group, Create a new business partner — response body — client group, Create a new business partner — response body — worker

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.