{
  "components": {
    "schemas": {
      "OutputReportsApiReportResponse1aeb7e00e75c": {
        "description": "The response object when creating a new report.",
        "properties": {
          "message": {
            "description": "The success or failure message for the generated report.",
            "type": "string"
          },
          "request_id": {
            "description": "The request ID for the generated report. This request ID will be used to retrieve the completed report.",
            "type": "string"
          }
        },
        "title": "ReportResponse",
        "type": "object"
      },
      "OutputReportsApiReportTemplate952fe87b6221": {
        "description": "A generic report template.",
        "properties": {
          "fieldDescriptionMap": {
            "description": "The available report fields. This will vary based on each report type.",
            "type": "object"
          },
          "templateDisplayName": {
            "description": "The display name of the report within Rippling.",
            "type": "string"
          },
          "templateName": {
            "description": "The internal name of the report to be used to programmatically access the report contents.",
            "type": "string"
          }
        },
        "title": "ReportTemplate",
        "type": "object"
      },
      "OutputReportsApiReportTemplates78253aae1252": {
        "description": "An object describing a report template name and id.",
        "properties": {
          "templateID": {
            "type": "string"
          },
          "templateName": {
            "type": "string"
          }
        },
        "required": [
          "templateID",
          "templateName"
        ],
        "title": "ReportTemplates",
        "type": "object"
      }
    }
  },
  "info": {
    "title": "Rippling reports-api",
    "version": "2026-10-28"
  },
  "openapi": "3.1.0",
  "paths": {
    "/platform/api/reports/report_data": {
      "get": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/reports-api/reference/get-reports-get-reports-data"
        },
        "operationId": "rippling.reports_api.get_reports_get_reports_data",
        "parameters": [
          {
            "in": "query",
            "name": "request_id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "Report_Template": {
                      "description": "An object representing a report. A report may contain multiple nested subreports. For example for SOC2, you can expect nested objects within the report for Access Control and Provisioning History. Use the report_template info to identify the structure of each report.",
                      "type": "object"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "OK"
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com"
          }
        ],
        "summary": "GET Report Data",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      },
      "post": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/reports-api/reference/post-reports"
        },
        "operationId": "rippling.reports_api.post_reports",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "report_name": {
                    "description": "The report type to be generated. For examples, use soc2, inventory, or insurance.",
                    "enum": [
                      "soc2",
                      "AccessControlList",
                      "'BackgroundCheckCandidate'",
                      "PerformanceManagementObjective",
                      "PerformanceManagementPulse",
                      "PerformanceManagementReview"
                    ],
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OutputReportsApiReportResponse1aeb7e00e75c"
                }
              }
            },
            "description": "OK"
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com"
          }
        ],
        "summary": "POST Report",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      }
    },
    "/platform/api/reports/report_templates": {
      "get": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/reports-api/reference/get-reports-report-templates"
        },
        "operationId": "rippling.reports_api.get_reports_report_templates",
        "parameters": [],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "items": {
                    "$ref": "#/components/schemas/OutputReportsApiReportTemplates78253aae1252"
                  },
                  "minItems": 1,
                  "type": "array",
                  "uniqueItems": true
                }
              }
            },
            "description": "OK"
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com"
          }
        ],
        "summary": "GET Available Report Templates",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      }
    },
    "/platform/api/reports/{report_template}/report_template_info": {
      "get": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/reports-api/reference/get-reports-report-template-report-template-info"
        },
        "operationId": "rippling.reports_api.get_reports_report_template_report_template_info",
        "parameters": [
          {
            "in": "path",
            "name": "report_template",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/OutputReportsApiReportTemplate952fe87b6221"
                  },
                  "type": "array"
                }
              }
            },
            "description": "OK"
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com"
          }
        ],
        "summary": "GET Report Template Information",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      }
    }
  }
}