Skip to content

Rippling: List Sites — response body — results item

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

API reference · Contract 2026-10-28

SDK schema: List Sites — response body — results item

FieldTypePresenceDescription and constraints
$objectRootResponse/resource shape for a custom site.
admin_group_idstringOptionalThe admin group id for the custom site
api_namestringOptionalThe unique api name of the custom site
created_atstringOptionalRecord creation date
created_bystringOptionalThe ID of the role that created the custom site
current_bundle_idstringOptionalThe active bundle id for the custom site
descriptionstringOptionalThe optional description of the custom site
idstringOptionalIdentifier field
logostringOptionalA Rippling-owned logo URL for the custom site
namestringOptionalThe display name of the custom site
viewer_group_idstringOptionalThe viewer group id for the custom site

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.