Skip to main content
GET
/
v1
/
dashboards
/
{dashboardId}
/
download
/
{jobId}
Download file
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/dashboards/{dashboardId}/download/{jobId} \
  --header 'Authorization: Bearer <token>'
"<string>"
Only call this endpoint when the Check download status endpoint returns a complete status.
Retrieves the completed dashboard download file. The response will include appropriate headers for the file type:
  • Content-Type - MIME type based on format (e.g., application/pdf)
  • Content-Disposition - Attachment with filename (e.g., attachment; filename="Dashboard Name.pdf")
  • Content-Length - File size in bytes (when available)

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
dashboardId
string
required

The dashboard identifier. This must match the ID of the original download request.

​
jobId
string<uuid>
required

The job ID returned from the Initiate dashboard download endpoint

Response

File download successful

The response is of type file.