Please ensure that you have reviewed the prerequisites before following this guide.
1. List all completed negotiations
Request
Negotiations are assigned to workspaces (Sub-Accounts). You can list the negotiations available to one of your workspaces using the endpoint:
We've used several parameters in this example, lets examine them:
- state=executed: Completed documents are known as Executed state documents in the API
- pageIndex, pageSize: The page you would like, and how big the pages should be. You can vary these parameters to get other pages of results.
- orderBy, orderDirection: How results should be sorted. In this case by the time of 'lastAction' (last modified by anyone) and descending.
š” Pro tip
If you're using this endpoint to poll CreateiQ regularly you may also wish to include a filter so that you only need to process negotiations that have changed since your last poll.
If you last listed negotiations at 10am (UTC) on 10th May 2025 and it's now 10:30am you could add a filter parameter to show you only negotiations that have changed in those thirty minutes like:
&filters=lastModified+gte+2025-05-10T10:00:00.000ZThis is a SCIM-like filter expression saying that 'lastModified' should be greater-than-or-equal-to ('gte') 10am on the 10th May 2025 UTC ('2025-05-10T10:00:00.000Z'). Multiple filters can be added separated by a comma (',') character.
Bringing that all together your query URL may look like:
Response
This endpoint returns:
- Summary data for all the negotiations that appear on this page
- Information about how many pages are available (i.e. page 1 of 1000)
- Lists of entities present in negotiations on this page for use in further filtering
- Aggregate counts for all pages (e.g. there are 100 'cancelled' negotiations across all pages)
- A read back of the parameters that were used to generate this response
We'll take this response forward into step 2.
2. Download the contents of each negotiation
Request
Looking at the
result key from the query we performed in Step 1 we have a list of negotiation summaries for this page of results. A standalone example of a single negotiation summary is in Appendix I below.There's quite a lot of information in a negotiation summary. To access all the information for a negotiation, including the answers entered by your user you'll need to fetch it. Taking all of the
id fields from the negotiation summaries to fill the :negotiationId parameter you can, for each one, call:GET https://sandbox-api.app.createiq.tech/api/v1/subAccounts/:subAccountId/negotiations/:negotiationId
Response
A full negotiation response is shown in Appendix II
š” Pro tip
If your intention is to download data for purely audit purposes it's also possible to generate a PDF for completed negotiations which shows every modification made to the negotiation, and who made it, over the course of its life in CreateiQ.
To download that PDF use the endpoint:
Appendix I: A single Negotiation Summary
{ "id": "01806037-f5db-188b-6302-4b5d7c60b8fe", "subAccountId": "017e4e47-c6b4-4bdc-3e78-f6ebd70d2725", "document": { "id": "0180602f-451b-6885-057e-875172552d8e", "state": "public", "year": 2022, "documentType": "NDA", "governingLaw": "N/A", "abbreviation": "oneNDA", "description": "oneNDA", "dateAdded": "2022-04-25", "hasSchema": true, "version": "2.1", "supportedExtensions": [ "pdf", "docx" ], "referenceFilesExtensions": [], "supportsOfflineNegotiations": true, "supportsBulkUpload": true, "supportsReservedElections": true, "supportsAuxiliaryDocumentUpload": false, "mustHaveAuxiliaryDocumentBeforeExecuted": true, "supportsForking": false, "mustHaveSignaturePagesBeforeExecuted": true, "showSimpleReceiverView": false, "initiatorCanUploadAllSignaturePages": false, "skipProposeDatePhase": false, "uploadFullDocumentsInsteadOfSignaturePages": false, "workflowType": "w1", "availableActions": { "createPreset": false, "createInvite": false, "swapParties": true, "canDownloadLockedDocx": false, "canDownloadUnlockedDocx": true, "canDownloadPdf": true }, "documentPack": { "id": "0180601c-1693-8592-7208-8defa79547ac", "documentPublisherId": "0178b6d9-4ab2-a7d8-8fa2-edf62e75600d", "name": "Standard Document Pack", "description": "Standard Document Pack", "isNew": false, "isVolumeBillingEnabled": false, "isInPublisherList": false, "state": "public", "disclaimer": "" }, "documentPublisher": { "id": "0178b6d9-4ab2-a7d8-8fa2-edf62e75600d", "name": "Test Publisher", "description": "Test Publisher", "code": "test_publisher", "defaultDisclaimer": {} }, "availability": "default", "copyMapping": { "...elided..." } }, "preset": { "name": "Bespoke" }, "state": "executed", "isTurn": false, "currentparty": "partyA", "counterparty": "partyB", "partyA": { "id": "084e56ec-e1fa-315e-a94f-05fb41261bc8", "name": "Party A" }, "partyB": { "id": "5622e008-2772-3b35-97f0-e4825b53dd09", "name": "Party B" }, "draftCounterparties": [], "activeUser": { "firstName": "David", "lastName": "Smith", "isCurrentUser": false, "isAdvisor": false }, "version": "6.0", "totalElections": 6, "matchingElections": 5, "dates": { "started": "2022-04-25T10:15:21.818992Z", "stateReached": "2022-04-25T10:22:08.985271Z", "execution": "2022-04-25", "invitationSent": "2022-04-25T10:16:41.112980Z", "lastModified": "2022-04-25T10:22:08.985271Z", "lastTurnSwap": "2022-04-25T10:22:08.985271Z", "lastNotification": "2022-04-25T10:16:41.112980Z", "nextNotificationAfter": "2022-04-25T10:18:41.112980Z", "previousForkDates": [] }, "chaserEmail": { "lastNotification": "2022-04-25T10:16:41.112980Z", "emailFailedToDeliver": false }, "customFields": {}, "health": "ok", "initiator": { "account": { "accountId": "00000000-0000-0000-0005-000000000001", "accountName": "Global Investment Bank" }, "user": { "id": "0176707c-4754-4738-b85a-2f11ca211e68", "firstName": "David", "lastName": "Smith", "email": "david@global-investment-bank.invalid" }, "invitationSentOn": "2022-04-25T10:16:41.112980Z" }, "receivers": [ { "account": { "accountId": "00000000-0000-0000-0005-000000000001", "accountName": "Global Investment Bank" }, "user": { "email": "sarah@other-investment-bank.invalid" } } ], "requestingPartyIsInitiator": true, "requester": { "position": "partyA" }, "parties": [ { "type": "established_party", "partyId": "01806037-f5db-519f-8a6a-e15fe4232109", "position": "partyA", "account": { "accountId": "00000000-0000-0000-0005-000000000001", "accountName": "Global Investment Bank" }, "entity": { "id": "084e56ec-e1fa-315e-a94f-05fb41261bc8", "name": "Party A" }, "activeUser": { "id": "0176707c-4754-4738-b85a-2f11ca211e68", "firstName": "David", "lastName": "Smith", "email": "david@global-investment-bank.invalid" }, "isTurn": false }, { "type": "established_party", "partyId": "01806039-2b88-c500-bed5-2b57ede01ed6", "position": "partyB", "account": { "accountId": "00000000-0000-0000-0005-000000000001", "accountName": "Global Investment Bank" }, "entity": { "id": "5622e008-2772-3b35-97f0-e4825b53dd09", "name": "Party B" }, "isTurn": false } ], "workflowType": "w1", "forkedFrom": [], "forkedTo": [] }
Appendix II: A single Negotiation
{ "id": "01806037-f5db-188b-6302-4b5d7c60b8fe", "subAccountId": "017e4e47-c6b4-4bdc-3e78-f6ebd70d2725", "document": { "id": "0180602f-451b-6885-057e-875172552d8e", "state": "public", "year": 2022, "documentType": "oneNDA", "governingLaw": "N/A", "abbreviation": "oneNDA", "description": "oneNDA", "dateAdded": "2022-04-25", "hasSchema": true, "version": "2.1", "supportedExtensions": [ "pdf", "docx" ], "referenceFilesExtensions": [], "supportsOfflineNegotiations": true, "supportsBulkUpload": true, "supportsReservedElections": true, "supportsAuxiliaryDocumentUpload": false, "mustHaveAuxiliaryDocumentBeforeExecuted": true, "supportsForking": false, "mustHaveSignaturePagesBeforeExecuted": true, "showSimpleReceiverView": false, "initiatorCanUploadAllSignaturePages": false, "skipProposeDatePhase": false, "uploadFullDocumentsInsteadOfSignaturePages": false, "workflowType": "w1", "availableActions": { "createPreset": false, "createInvite": false, "swapParties": true, "canDownloadLockedDocx": false, "canDownloadUnlockedDocx": true, "canDownloadPdf": true }, "documentPack": { "id": "0180601c-1693-8592-7208-8defa79547ac", "documentPublisherId": "0178b6d9-4ab2-a7d8-8fa2-edf62e75600d", "name": "Standard Document Pack", "description": "Standard Document Pack", "isNew": false, "isVolumeBillingEnabled": false, "isInPublisherList": false, "state": "public", "disclaimer": "" }, "documentPublisher": { "id": "0178b6d9-4ab2-a7d8-8fa2-edf62e75600d", "name": "Test Publisher", "description": "Test Publisher", "code": "test_publisher", "defaultDisclaimer": {} }, "availability": "default", "copyMapping": { "...elided..." } }, "preset": { "name": "Bespoke" }, "answers": { "partyA": { "parties": { "partyA_name": "Party A", "partyB_name": "Party B" }, "signature_blocks": { "type_of_signing": "hand-signing", "partyA_standard": "Signature:\n\nDate:\n\nName and Title:\n\nCompany:\n\nNotice Address *(choose type):*\nā Email:\nā Postal mail:", "partyB_standard": "Signature:\n\nDate:\n\nName and Title:\n\nCompany:\n\nNotice Address *(choose type):*\nā Email:\nā Postal mail:" }, "confidentiality_period": { "confidentiality_period_is": "perpetual" }, "term_of_nda": { "term_of_nda_is": "nda_continues_until_terminated" }, "execution_date": { "executionDate": "2022-04-25" }, "governing_law_courts": { "governing_law_is": "xxxx", "courts_is": "vvvv" } }, "partyB": { "parties": { "partyA_name": "Party A", "partyB_name": "Party B" }, "signature_blocks": { "type_of_signing": "hand-signing", "partyA_standard": "Signature:\n\nDate:\n\nName and Title:\n\nCompany:\n\nNotice Address *(choose type):*\nā Email:\nā Postal mail:", "partyB_standard": "Signature:\n\nDate:\n\nName and Title:\n\nCompany:\n\nNotice Address *(choose type):*\nā Email:\nā Postal mail:" }, "confidentiality_period": { "confidentiality_period_is": "perpetual" }, "term_of_nda": { "term_of_nda_is": "nda_continues_until_terminated" }, "execution_date": { "executionDate": "2022-04-25" }, "governing_law_courts": { "governing_law_is": "xxxx", "courts_is": "vvvv" } } }, "state": "executed", "isTurn": false, "currentparty": "partyA", "counterparty": "partyB", "partyA": { "id": "084e56ec-e1fa-315e-a94f-05fb41261bc8", "name": "Party A" }, "partyB": { "id": "5622e008-2772-3b35-97f0-e4825b53dd09", "name": "Party B" }, "draftCounterparties": [], "activeUser": { "firstName": "David", "lastName": "Smith", "isCurrentUser": false, "isAdvisor": false }, "version": "6.0", "totalElections": 6, "matchingElections": 5, "availableActions": { "view": true, "edit": false, "assignUser": false, "assignToMe": false, "setPreset": false, "setMultipleCounterparties": false, "setCounterparty": false, "setCounterpartyEntity": false, "sendToCounterparty": false, "confirm": false, "confirmExecutionVersion": false, "downloadDocument": true, "cancel": false, "setExecutionDate": false, "revertToAmending": false, "revertToExecutionAmending": false, "approveDocument": false, "rejectDocument": false, "sendForApproval": false, "approveDocumentOverride": false, "rejectDocumentOverride": false, "approveElectionOverride": false, "rejectElectionOverride": false, "setElectionApprovals": false, "setDocumentApprovals": false, "uploadDeleteSignature": false, "sendChaserEmails": false, "setInitiatorEntity": false, "canInvite": false, "markAsOffline": false, "markAsFinal": false, "notifyOfDraft": false, "uploadDeleteAuxiliaryDocument": false, "fork": false, "uploadDeleteExecutedVersion": false, "markElectionReserved": false, "unmarkElectionReserved": false }, "availableChannels": { "internal": true, "external": true, "moderator": false }, "counterpartyHasValidElections": true, "dates": { "started": "2022-04-25T10:15:21.818992Z", "stateReached": "2022-04-25T10:22:08.985271Z", "execution": "2022-04-25", "invitationSent": "2022-04-25T10:16:41.112980Z", "lastModified": "2022-04-25T10:22:08.985271Z", "lastTurnSwap": "2022-04-25T10:22:08.985271Z", "lastNotification": "2022-04-25T10:16:41.112980Z", "nextNotificationAfter": "2022-04-25T10:18:41.112980Z", "previousForkDates": [] }, "chaserEmail": { "lastNotification": "2022-04-25T10:16:41.112980Z", "emailFailedToDeliver": false }, "electionApprovals": {}, "electionsToApprove": [], "fileExtensionsSupported": [ "pdf", "docx" ], "customFields": {}, "health": "ok", "initiator": { "account": { "accountId": "00000000-0000-0000-0005-000000000001", "accountName": "Global Investment Bank" }, "user": { "id": "0176707c-4754-4738-b85a-2f11ca211e68", "firstName": "David", "lastName": "Smith", "email": "david@global-investment-bank.invalid" }, "invitationSentOn": "2022-04-25T10:16:41.112980Z" }, "receivers": [ { "account": { "accountId": "00000000-0000-0000-0005-000000000001", "accountName": "Global Investment Bank" }, "user": { "email": "sarah@other-investment-bank.invalid" } } ], "requestingPartyIsInitiator": true, "requester": { "position": "partyA" }, "groupMemberSummaries": [], "parties": [ { "type": "established_party", "partyId": "01806037-f5db-519f-8a6a-e15fe4232109", "position": "partyA", "account": { "accountId": "00000000-0000-0000-0005-000000000001", "accountName": "Global Investment Bank" }, "entity": { "id": "084e56ec-e1fa-315e-a94f-05fb41261bc8", "name": "Party A" }, "activeUser": { "id": "0176707c-4754-4738-b85a-2f11ca211e68", "firstName": "David", "lastName": "Smith", "email": "david@global-investment-bank.invalid" }, "isTurn": false }, { "type": "established_party", "partyId": "01806039-2b88-c500-bed5-2b57ede01ed6", "position": "partyB", "account": { "accountId": "00000000-0000-0000-0005-000000000001", "accountName": "Global Investment Bank" }, "entity": { "id": "5622e008-2772-3b35-97f0-e4825b53dd09", "name": "Party B" }, "isTurn": false } ], "workflowType": "w1", "nestedAnswersSummaries": {}, "reservedElectionIds": [], "forkedFrom": [], "forkedTo": [], "supportsESignature": false }
Ā