---
updatedAt: 2025-07-22T07:42:49.000Z
---
Fetch the complete documentation index at: https://apidocs.hibob.com/llms.txt. Use this file to discover all available pages before exploring further.
# Download a report by the report name.
Downloads the report that was generated with the Get the report download URL for polling endpoint.
To download the report:
1. Use the [Get the report download URL for polling](https://apidocs.hibob.com/reference/get_company-reports-reportid-download-async) endpoint to obtain the report URL.
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.
For example: `https://app.hibob.com/v1/company/reports/download/2022-06-17T11_22_14.798810-test.JsonFormat`
3. If you receive 204 error response, this means the reports is not ready yet. In this case you should try again.
Permissions required:
The service user that you use for this call should have the required permissions. To learn more, see [Reports permissions](https://apidocs.hibob.com/reference/reports).
# OpenAPI definition
```json
{
"openapi": "3.1.1",
"info": {
"title": "Reports API",
"description": "Use Public API to access Reports in Bob",
"license": {
"name": "Proprietary",
"url": "https://apidocs.hibob.com/docs/api-terms-of-use"
},
"contact": {
"name": "Hi Bob, Inc."
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.hibob.com/v1",
"description": "Production"
},
{
"url": "https://api.sandbox.hibob.com/v1",
"description": "Sandbox"
}
],
"x-readme": {
"metrics-enabled": false
},
"paths": {
"/company/reports/download/{reportName}": {
"get": {
"operationId": "get_company-reports-download-reportname",
"tags": [
"Reports"
],
"summary": "Download a report by the report name.",
"description": "Downloads the report that was generated with the Get the report download URL for polling endpoint.
To download the report:
1. Use the Get the report download URL for polling endpoint to obtain the report URL.
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.
For example: `https://app.hibob.com/v1/company/reports/download/2022-06-17T11_22_14.798810-test.JsonFormat`
3. If you receive 204 error response, this means the reports is not ready yet. In this case you should try again.
Permissions required:
The service user that you use for this call should have the required permissions. To learn more, see Reports permissions.",
"parameters": [
{
"name": "reportName",
"in": "path",
"description": "Report name. You should obtain the report name from the generated report URL in the Get the report download URL for polling endpoint.
",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Include the report name and execution date in the report file. This defaults to true.",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"204": {
"description": "The file is not yet ready, please try again.",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"429": {
"description": "Rate limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"security": [
{
"basic": []
},
{
"Bearer": []
}
]
}
}
},
"components": {
"schemas": {
"ApiErrorResponse": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The unique identifier of the error."
},
"error": {
"type": "string",
"description": "A human readable error message."
}
}
}
},
"securitySchemes": {
"basic": {
"type": "http",
"scheme": "basic",
"description": "Basic HTTP authentication using service user credentials"
},
"Bearer": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "OAuth 2.0",
"description": "OAuth 2.0 authentication using an Access Token is available for registered partners only. Try It! does not support the full HiBob OAuth flow. You can follow these steps to complete the OAuth 2.0 flow in Postman and then paste the token here."
}
}
}
}
```