← Reports API operations · All schemas
GET Available Report Templates — response body — item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | An object describing a report template name and id. |
templateID | string | Required within parent | |
templateName | string | Required within parent | |
GET Report Template Information — response body — item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A generic report template. |
fieldDescriptionMap | object | Optional | The available report fields. This will vary based on each report type. |
templateDisplayName | string | Optional | The display name of the report within Rippling. |
templateName | string | Optional | The internal name of the report to be used to programmatically access the report contents. |
POST Report — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | The response object when creating a new report. |
message | string | Optional | The success or failure message for the generated report. |
request_id | string | Optional | The request ID for the generated report. This request ID will be used to retrieve the completed report. |