ClientsOperation documents.file

Documents file

A ten-minute link to an uploaded document's file (download=1 to download).

GET/api/v1/documents/{id}/file

Scope read: Read anything in the workspace.

Parameters

Name	In	Description
`id`required	path	The record's id.

Name	In	Description
`download`	query	1 to download instead of view.

curl

curl -X GET "https://crm.ashwanth.dev/api/v1/documents/{id}/file" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY"

CLI

sales-engine documents file <id>

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape

{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Runs against this server, as the workspace behind the key.

API key

Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.

Path

idrequired

The record's id.

Query

download

1 to download instead of view.

Request

GET /api/v1/documents/%7Bid%7D/file

Fill the path first.