Download the report by ID

get

https://api.hibob.com/v1/company/reports/{reportId}/download

Returns a report data file in the specified format.
Supported user types: Service.

Permissions required:
The service user that you use for this call should have the required permissions. To learn more, see Reports permissions.

Path Params

reportId

number

required

The ID of the report to download. You can get this from the response of Read company reports ↗, or from the report’s URL in Bob's UI.

Note⚠️: 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 Params

format

string

enum

required

Defaults to csv

File format

Allowed:

includeInfo

boolean

Should include info.

locale

string

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.

humanReadable

string

Optional field. Only enforced when format is json.
If not sent: supply machine-readable values only. If you pass an invalid value it will be ignored.

Possible values:

APPEND - include the additional "humanReadable" JSON node in the response.

REPLACE - supply humanReadable values in JSON instead of machine-readable format.

Responses

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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

400Bad Request

401Unauthorized

404Not Found

429Rate limit exceeded

500Internal server error