crm

Read a CRM CSV export's progress, and its file path and download link once done

Read a CRM CSV export's progress, and its file path and download link once done.

get/crm/exports/{jobId}

Request

  • Base URL
    https://www.dench.com/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

jobIdstring required

jobId returned by crm.exports.start.

Response

Successful response

jobIdstring required
status'running' | 'done' | 'failed' required
objectNamestring required
rowsDonenumber required
totalRowsnumber

Estimated total, only for an unfiltered, unscoped export.

truncatedboolean required

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

filePathstring

Workspace path once done.

downloadUrlstring

Signed link once done.

bytesnumber
errorstring
messagestring required

One-line status to show the person.

alreadyRunningboolean

start returned the workspace's running export instead.

createdAtnumber required
finishedAtnumber

Changes

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