DEAL

Gets all assigned documents for a deal.

GET/api/v2/deals/{dealId}/documents

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

dealIdpathinteger · int32required

The deal ID.

Responses

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

An array. Each item is a DealAssignedDocumentDto:

assignedDocumentIdinteger · int32
dealIdinteger · int32
descriptionstring
commentsstring
categorystring
namestring

REQUEST EXAMPLE

curl --request GET \
  'https://apiv2.crmseries.com/api/v2/deals/DEAL_ID/documents' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": [
    {
      "assignedDocumentId": 1024,
      "dealId": 1024,
      "description": "string",
      "comments": "string",
      "category": "string",
      "name": "string"
    }
  ],
  "errors": []
}