Skip to main content
GET
Read a CRM CSV export's progress, and its file path and download link once done

Authorizations

Authorization
string
header
required

Workspace-scoped Dench API key from workspace settings. This is the same key used by DENCH_API_KEY in sandboxes.

Path Parameters

jobId
string
required

jobId returned by crm.exports.start.

Response

Successful response

jobId
string
required
status
enum<string>
required
Available options:
running,
done,
failed
objectName
string
required
rowsDone
number
required
truncated
boolean
required

The export stopped at its 50,000-row cap and more records may match.

message
string
required

One-line status to show the person.

createdAt
number
required
totalRows
number

Estimated total, only for an unfiltered, unscoped export.

filePath
string

Workspace path once done.

downloadUrl
string

Signed link once done.

bytes
number
error
string
alreadyRunning
boolean

start returned the workspace's running export instead.

finishedAt
number