ConnectCloud Developers

List the sales documents of an opportunity (tenant:crm:read)

GET /api/crm/v1/opportunities/{id}/documents

Module: CRM · operationId: listOpportunityDocuments · Tag: Opportunities · Auth: access token (Authorization: Bearer <accessToken>)

The trade documents (offers, orders and the documents made from them) that name the opportunity (opportunityId in trade), as the CRM keeps them from trade's event feed – newest change first, every revision on its own. A deleted document disappears. The CRM reacts to them: a new offer or order is a SYSTEM activity of the opportunity; an offer that becomes ACCEPTED or a new order moves an open opportunity to the tenant's first won stage (crm.opportunity.won); an offer that becomes REJECTED, EXPIRED or REVOKED is only noted (a person decides whether the opportunity is lost). Read the documents themselves through the trade API (transactionId).

Parameters

Name In Type Required Description
id path string (uuid) yes Record ID (UUID).

Responses

  • 200 The documents (all of them; no paging). (application/json)
  • 401 Missing, invalid or expired token (no body).
  • 403 The token lacks the permission (insufficient permissions) or has no active tenant. (application/json)
  • 404 The record does not exist in the token's tenant. (application/json)
  • 500 Unexpected error; details are only logged. (application/json)

Fields of the 200 answer:

  • items (array of OpportunityDocument, required): Documents of the opportunity.
    • createdAt (string (date-time), required): When the CRM first saw the document.
    • netTotal (number (double), required): Net total of the document.
    • number (string, required): Document number in trade.
    • opportunityId (string (uuid), required): The opportunity the document names.
    • status (string, required): Status in trade, e.g. DRAFT, SENT, ACCEPTED, REJECTED, EXPIRED, REVOKED, CONFIRMED.
    • transactionId (string (uuid), required): Id of the document in trade.
    • type (string, required): Trade document type, e.g. OFFER, ORDER, DELIVERY_NOTE, INVOICE.
    • updatedAt (string (date-time), required): Last change the CRM saw.
    • version (integer, required): Revision of the document (each revision is its own document).
    • sourceTransactionId (string (uuid)): The document this one was made from (the offer of an order). Omitted when not set.
  • total (integer, required): Number of documents.

Example 200 answer:

{
  "items": [
    {
      "createdAt": "2026-11-06T10:30:00Z",
      "netTotal": 18400,
      "number": "AN-2026-0012",
      "opportunityId": "7d9f1b3d-5e7a-4c9b-8f1d-5c7e9a1b3d5f",
      "status": "SENT",
      "transactionId": "2b4d6f8b-0c2e-4a4c-8e6a-0c2e4a6c8e0a",
      "type": "OFFER",
      "updatedAt": "2026-11-12T16:40:00Z",
      "version": 2
    }
  ],
  "total": 1
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/crm/v1/opportunities/3f2b8c1e-6d4a-4f7b-9a2e-1c5d7e9f0a12/documents' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI