Sales Engine
API documentation
ClientsOperation documents.list

Documents list

Documents on a deal, newest first, without the body.

GET/api/v1/deals/{id}/documents
Scope read: Read anything in the workspace.

Parameters

Path

NameInDescription
idrequiredpathThe record's id.

Example

curl
curl -X GET "https://crm.ashwanth.dev/api/v1/deals/{id}/documents" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY"
CLI
sales-engine documents list <id>

Response

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.

Try it

Runs against this server, as the workspace behind the 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
required
The record's id.
Request
GET /api/v1/deals/%7Bid%7D/documents
Fill the path first.

Also in Clients