Skip to content

Rippling: Reports API schemas

3 Rippling schemas with complete fields and constraints.

← Reports API operations · All schemas

GET Available Report Templates — response body — item

FieldTypePresenceDescription and constraints
$objectRootAn object describing a report template name and id.
templateIDstringRequired within parent
templateNamestringRequired within parent

GET Report Template Information — response body — item

FieldTypePresenceDescription and constraints
$objectRootA generic report template.
fieldDescriptionMapobjectOptionalThe available report fields. This will vary based on each report type.
templateDisplayNamestringOptionalThe display name of the report within Rippling.
templateNamestringOptionalThe internal name of the report to be used to programmatically access the report contents.

POST Report — response body

FieldTypePresenceDescription and constraints
$objectRootThe response object when creating a new report.
messagestringOptionalThe success or failure message for the generated report.
request_idstringOptionalThe request ID for the generated report. This request ID will be used to retrieve the completed report.

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.