Skip to content

Rippling: List kiosk badges — response body — results item

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

API reference · Contract 2026-10-28

SDK schema: List kiosk badges — response body — results item

FieldTypePresenceDescription and constraints
$objectRoot
badge_idstringRequired within parentThe ID associated with the badge. Not to be confused with the record’s ID.
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
is_enabledbooleanOptionalWhether this badge can be used with the Kiosk app.
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Update a kiosk badge — response body — worker
worker_idstringOptionalThe ID of the worker associated with the badge.
worker_numberJSONOptional
worker_number (anyOf 1)integerAlternativeThe employee number of the worker associated with the badge.
worker_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Update a kiosk badge — 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.