DEdench
crm

Start a server-side CSV export of a CRM object into the workspace files (/exports). Returns at once; one export runs per workspace, and a second start returns the running one

Start a server-side CSV export of a CRM object into the workspace files (/exports). Returns at once; one export runs per workspace, and a second start returns the running one.

post/crm/exports

Request

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

Request body

objectNamestring required
columnsstring[]

Fields to export, in order. Default: every field except the long-text Notes.

whereobject

Filter in the crm.query DSL, e.g. {"Status":"Open"} or {"Score":{"$gte":50}}. Field names are case-sensitive.

assignedTostring

Personal scope: "me" (the signed-in member / the human behind an agent session), "unassigned", or a member userId or email. Adds one has_any / is_empty rule on the object's assignee user field; rows, totalCount, sums and analytics all follow it. Never saved onto the view.

assigneeFieldstring

Which user field "assigned" means. Default: the analytics owner role, else the task Assignee, else a user field named like owner/assignee, else the first user field.

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.