HIhibob
Reports

Download the report by ID

Returns a report data file in the specified format.<br /> <b>Supported user types:</b> Service. <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 Reports permissions.

get/company/reports/{reportId}/download

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/company/reports/{reportId}/download
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

reportIdnumber required

The ID of the report to download. You can get this from the response of <a href="https://apidocs.hibob.com/reference/get_company-reports" target="_blank">Read company reports ↗</a>, or from the report’s URL in Bob's UI. <br /><br /> <b>Note⚠️:</b> To use this endpoint, replace reportId in the path with a valid report ID from your account. If left blank or set to an invalid ID, the request will return an error.

Query parameters

format'csv' | 'xlsx' | 'json' required

File format

includeInfoboolean

Should include info.

localestring

Requested language for the report columns in the format of locale (e.g. fr-FR). If this is not provided, the user preferences locale is used.

humanReadablestring

Optional field. Only enforced when <i><b>format</b></i> is <i>json</i>. <br> <b>If not sent:</b> supply machine-readable values only. If you pass an invalid value it will be ignored.<br> <br> Possible values: <br> <br> <b>APPEND</b> - include the additional "humanReadable" JSON node in the response. <br> <br> <b>REPLACE</b> - supply humanReadable values in JSON instead of machine-readable format. <br>

Response

Includes the report name and execution date in the report file. By default this is set to True.

string binary required

Changes

No recorded changes to this operation across all 1 revision of this API.