v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Reports

Download a report by the report name.

Downloads the report that was generated with the Get the report download URL for polling endpoint.<br /> <br />To download the report:<br /> 1. Use the <a href="https://apidocs.hibob.com/reference/get_company-reports-reportid-download-async" target="_blank">Get the report download URL for polling</a> endpoint to obtain the report URL.<br /> 2. Copy only the name of the report (after the /download/) from the URL returned in the response header, and use it as the reportName for download. <br /><br />For example: https://app.hibob.com/v1/company/reports/download/2022-06-17T11_22_14.798810-test.JsonFormat<br /> 3. If you receive 204 error response, this means the reports is not ready yet. In this case you should try again.<br /> <br /> <b>Permissions required:</b> <br /> The service user that you use for this call should have the required permissions. To learn more, see <a href="https://apidocs.hibob.com/reference/reports" target="_blank">Reports permissions</a>.

get/company/reports/download/{reportName}

Path parameters

reportNamestring required

Report name. You should obtain the report name from the generated report URL in the <a href="https://apidocs.hibob.com/reference/get_company-reports-reportid-download-async" target="_blank">Get the report download URL for polling</a> endpoint.<br />

Response

Include the report name and execution date in the report file. This defaults to true.

string binary required