{ "info": { "name": "Summize API", "description": "Summize External API collection.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "apikey", "apiKey": [ { "key": "key", "value": "Ocp-Apim-Subscription-Key", "type": "string" }, { "key": "value", "value": "{{subscriptionKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api-gateway.summize.com/api", "description": "API base URL. Set this to your environment\u0027s APIM gateway URL." }, { "key": "subscriptionKey", "value": "", "description": "Your subscription key. Obtain one in the settings area of your Summize app." }, { "key": "requestorEmail", "value": "", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." }, { "key": "userId", "value": "", "description": "GUID of the user requesting the download. Either this OR \u0060outboundIntegrationId\u0060 must be supplied." }, { "key": "outboundIntegrationId", "value": "", "description": "GUID of the outbound integration making the request. Either this OR \u0060userId\u0060 must be supplied." } ], "item": [ { "name": "Documents", "description": "Download main documents, linked documents and attachments.", "item": [ { "name": "Downloads", "item": [ { "name": "Download an attachment", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/:documentId/attachments/:attachmentId/download", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":documentId", "attachments", ":attachmentId", "download" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "attachmentId", "value": "" } ], "query": [ { "key": "userId", "value": "{{userId}}", "description": "GUID of the user requesting the download. Either this OR \u0060outboundIntegrationId\u0060 must be supplied." }, { "key": "outboundIntegrationId", "value": "{{outboundIntegrationId}}", "description": "GUID of the outbound integration making the request. Either this OR \u0060userId\u0060 must be supplied." } ] }, "description": "Downloads an attachment from a document. Returns a redirect to the file." } }, { "name": "Download main document", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/:documentId/download", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":documentId", "download" ], "variable": [ { "key": "documentId", "value": "" } ], "query": [ { "key": "userId", "value": "{{userId}}", "description": "GUID of the user requesting the download. Either this OR \u0060outboundIntegrationId\u0060 must be supplied." }, { "key": "outboundIntegrationId", "value": "{{outboundIntegrationId}}", "description": "GUID of the outbound integration making the request. Either this OR \u0060userId\u0060 must be supplied." } ] }, "description": "Downloads the main document. Returns a redirect to the file." } }, { "name": "Download a linked document", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/:documentId/linkeddocuments/:linkedDocumentId/download", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":documentId", "linkeddocuments", ":linkedDocumentId", "download" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "linkedDocumentId", "value": "" } ], "query": [ { "key": "userId", "value": "{{userId}}", "description": "GUID of the user requesting the download. Either this OR \u0060outboundIntegrationId\u0060 must be supplied." }, { "key": "outboundIntegrationId", "value": "{{outboundIntegrationId}}", "description": "GUID of the outbound integration making the request. Either this OR \u0060userId\u0060 must be supplied." } ] }, "description": "Downloads a linked document. Returns a redirect to the file." } } ] }, { "name": "Calendar Events", "item": [ { "name": "Get calendar events", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/v2/calendar-events", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", "calendar-events" ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Delete a calendar event", "request": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/calendar-events/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "calendar-events", ":eventId" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "eventId", "value": "" } ] } } }, { "name": "Get a calendar event", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/calendar-events/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "calendar-events", ":eventId" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "eventId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Update a calendar event", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/calendar-events/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "calendar-events", ":eventId" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "eventId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022,\r\n \u0022eventType\u0022: 0,\r\n \u0022eventDate\u0022: \u00222026-01-01T00:00:00Z\u0022,\r\n \u0022description\u0022: {},\r\n \u0022clauseId\u0022: 0,\r\n \u0022noticePeriod\u0022: 0,\r\n \u0022reminderDates\u0022: {},\r\n \u0022includeInSummaryEmails\u0022: false,\r\n \u0022isHiddenFromCalendar\u0022: false,\r\n \u0022isEvergreen\u0022: false\r\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get calendar events for a document", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/calendar-events", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "calendar-events" ], "variable": [ { "key": "documentId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Create a calendar event", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/calendar-events", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "calendar-events" ], "variable": [ { "key": "documentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022,\r\n \u0022eventType\u0022: 0,\r\n \u0022eventDate\u0022: \u00222026-01-01T00:00:00Z\u0022,\r\n \u0022description\u0022: {},\r\n \u0022clauseId\u0022: 0,\r\n \u0022noticePeriod\u0022: 0,\r\n \u0022reminderDates\u0022: {},\r\n \u0022includeInSummaryEmails\u0022: false,\r\n \u0022isHiddenFromCalendar\u0022: false,\r\n \u0022isEvergreen\u0022: false\r\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Custom Fields", "item": [ { "name": "Delete custom field", "request": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/customfields/:customFieldId", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "customfields", ":customFieldId" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "customFieldId", "value": "" } ] } } }, { "name": "Update custom field", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/customfields/:customFieldId", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "customfields", ":customFieldId" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "customFieldId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022value\u0022: \u0022\u0022,\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get custom fields", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/customfields", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "customfields" ], "variable": [ { "key": "documentId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Create custom field", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/customfields", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "customfields" ], "variable": [ { "key": "documentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022fieldValues\u0022: [\r\n {\r\n \u0022customFieldId\u0022: \u0022\\u003CcustomFieldId\\u003E\u0022,\r\n \u0022value\u0022: \u0022\u0022\r\n }\r\n ],\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Metadata", "item": [ { "name": "Get document metadata", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/meta", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "meta" ], "variable": [ { "key": "documentId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } } ] }, { "name": "Name", "item": [ { "name": "Get document name", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/name", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "name" ], "variable": [ { "key": "documentId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Update document name", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/name", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "name" ], "variable": [ { "key": "documentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022documentName\u0022: \u0022\u0022,\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "E-Signature", "item": [ { "name": "Get e-signature status", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/esignature", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "esignature" ], "variable": [ { "key": "documentId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } } ] }, { "name": "Owner", "item": [ { "name": "Get document owner", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/owner", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "owner" ], "variable": [ { "key": "documentId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Update document owner", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/owner", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "owner" ], "variable": [ { "key": "documentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022ownerId\u0022: \u0022\\u003CownerId\\u003E\u0022,\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Parties", "item": [ { "name": "Delete party", "request": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "parties", ":partyId" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "partyId", "value": "" } ] } } }, { "name": "Get document parties", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/parties", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "parties" ], "variable": [ { "key": "documentId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Create party", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/parties", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "parties" ], "variable": [ { "key": "documentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022,\r\n \u0022realPartyName\u0022: \u0022\u0022\r\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Relationships", "item": [ { "name": "Create document relationship", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/relationships", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "relationships" ], "variable": [ { "key": "documentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022targetContractId\u0022: \u0022\\u003CtargetContractId\\u003E\u0022,\r\n \u0022type\u0022: \u0022\u0022,\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get document relationships", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/relationships", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "relationships" ], "variable": [ { "key": "documentId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Delete document relationship", "request": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/relationships/:relationshipId", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "relationships", ":relationshipId" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "relationshipId", "value": "" } ] } } } ] }, { "name": "Tasks", "item": [ { "name": "Complete task", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/tasks/:taskId/complete", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "tasks", ":taskId", "complete" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "taskId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022completionNotes\u0022: {},\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create task", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/tasks", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "tasks" ], "variable": [ { "key": "documentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022title\u0022: \u0022\u0022,\r\n \u0022description\u0022: {},\r\n \u0022type\u0022: 0,\r\n \u0022dueDate\u0022: \u00222026-01-01T00:00:00Z\u0022,\r\n \u0022assignments\u0022: {},\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get tasks", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/tasks", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "tasks" ], "variable": [ { "key": "documentId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Delete task", "request": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/tasks/:taskId", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "tasks", ":taskId" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "taskId", "value": "" } ] } } }, { "name": "Update task", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/documents/v2/:documentId/tasks/:taskId", "host": [ "{{baseUrl}}" ], "path": [ "documents", "v2", ":documentId", "tasks", ":taskId" ], "variable": [ { "key": "documentId", "value": "" }, { "key": "taskId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022title\u0022: \u0022\u0022,\r\n \u0022description\u0022: {},\r\n \u0022dueDate\u0022: \u00222026-01-01T00:00:00Z\u0022,\r\n \u0022isComplete\u0022: {},\r\n \u0022assignments\u0022: {},\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Repository", "description": "Post-signature: manage repository folders and subfolders.", "item": [ { "name": "Folders", "item": [ { "name": "Get folders", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/repository/folders", "host": [ "{{baseUrl}}" ], "path": [ "repository", "folders" ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Create folder", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/repository/folders", "host": [ "{{baseUrl}}" ], "path": [ "repository", "folders" ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022folderName\u0022: \u0022\u0022,\r\n \u0022folderDisplayId\u0022: {},\r\n \u0022businessSector\u0022: {},\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get subfolders", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/repository/folders/:folderId/subfolders", "host": [ "{{baseUrl}}" ], "path": [ "repository", "folders", ":folderId", "subfolders" ], "variable": [ { "key": "folderId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Create subfolder", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/repository/folders/:folderId/subfolders", "host": [ "{{baseUrl}}" ], "path": [ "repository", "folders", ":folderId", "subfolders" ], "variable": [ { "key": "folderId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022subfolderName\u0022: \u0022\u0022,\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Repository", "item": [ { "name": "Get a list of repository documents", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/repository", "host": [ "{{baseUrl}}" ], "path": [ "repository" ], "query": [ { "key": "skip", "value": "", "description": "Zero-based offset for paging - number of documents to skip before returning results. Must be non-negative." }, { "key": "take", "value": "", "description": "Page size - maximum number of documents to return. Defaults to 10, capped at 100. If set to 0 will return only a count." }, { "key": "sortField", "value": "", "description": "Field name to sort the result set by. Defaults to \u0022Created\u0022." }, { "key": "order", "value": "", "description": "Sort direction, \u0022asc\u0022 or \u0022desc\u0022. Defaults to \u0022desc\u0022." }, { "key": "query", "value": "", "description": "Free-text search term applied to document name, reference or party name." }, { "key": "folder", "value": "", "description": "Filter by folder identifier; restricts results to documents within the specified folder. Comma separated values per folder. Root folders prefixed with \u0022C:{ID}\u0022 and subfolders prefixed with \u0022M:{ID}\u0022" }, { "key": "contractType", "value": "", "description": "Filter by Contract Type Id. Comma separated values of Contract Type Ids." }, { "key": "owner", "value": "", "description": "Filter by document owner. Comma separated values of User IDs." }, { "key": "addedBy", "value": "", "description": "Filter by document requestor. Comma separated values of User IDs." }, { "key": "party", "value": "", "description": "Filter by party name on the document. Comma separated values of party names." }, { "key": "missingCustomField", "value": "", "description": "Filter by documents without the custom fields ID. Comma separated values of Custom Field IDs." }, { "key": "status", "value": "", "description": "Filter by Status. Comma separated values of document status. Possible values [NoValue, Draft, Negotiation, Completed, Negotiation3rdParty, Active, Expired, Archived, Open, Closed, Abandoned, NotSet]" }, { "key": "filter", "value": "", "description": "Pre-made common filters. Possible values [HasRedFlags, HasCalendarEvents, HasPendingTasks, AllOverdueTasks, AllTasksWithNoDueDate, NoPendingTasks, Next48Hours, TasksNotYetDue]" }, { "key": "redFlag", "value": "", "description": "Filters documents based on the passed in value. Possible values [NotSet, HasRedFlags, HasNoRedFlags]" }, { "key": "linkedDocs", "value": "", "description": "Filters documents based on the passed in value. Possible values [NotSet, HasLinkedDocs, HasNoLinkedDocs]" }, { "key": "addedFrom", "value": "", "description": "Lower bound (inclusive) for the date a document was added." }, { "key": "addedTo", "value": "", "description": "Upper bound (inclusive) for the date a document was added." }, { "key": "eventsFrom", "value": "", "description": "Lower bound for filtering on contract event dates." }, { "key": "eventsTo", "value": "", "description": "Upper bound for filtering on contract event dates." }, { "key": "excludedDocuments", "value": "", "description": "Document IDs to omit from results \u2014 typically used to hide already-selected items." }, { "key": "restrictToDocuments", "value": "", "description": "Document IDs to restrict the result set to; an empty array means no restriction." }, { "key": "withClause", "value": "", "description": "Filter by clauses that are on the document. Comma separated values of clause names to filter by." }, { "key": "withoutClause", "value": "", "description": "Filter by clauses that are not on the document. Comma separated values of clause names to filter by." }, { "key": "withEventClause", "value": "", "description": "Filter by clauses that are on an event of the documents. Comma separated values of clause names to filter by." }, { "key": "columns", "value": "", "description": "Comma separated values of columns to return for clauses and custom fields." }, { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } } ] } ] }, { "name": "Requests", "description": "Pre-signature: multi-step workflows for creating, reviewing, and managing contracts.", "item": [ { "name": "Requests", "item": [ { "name": "Get a list of request documents", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/requests", "host": [ "{{baseUrl}}" ], "path": [ "requests" ], "query": [ { "key": "source", "value": "", "description": "Filter by source type of the document." }, { "key": "requestor", "value": "", "description": "Filter by requestor User ID." }, { "key": "requestorGroup", "value": "", "description": "Filter by requestor Group ID." }, { "key": "assignedTo", "value": "", "description": "Filter by assigned-to User ID." }, { "key": "assignedToGroup", "value": "", "description": "Filter by assigned-to Group ID." }, { "key": "template", "value": "", "description": "Filter by template ID." }, { "key": "templateLookup", "value": "", "description": "Free-form text search in template names." }, { "key": "filter", "value": "", "description": "Pre-made filter type. Possible values [NoFilter, OnlyArchived]." }, { "key": "requestSubtype", "value": "", "description": "Filter by request subtype. Possible values [All, Standard, Freeform]." }, { "key": "status", "value": "", "description": "Filter by status. Comma separated values of RequestStageEnum names: Draft, Open, Negotiation, Negotiation3rdParty, ReadyForSignature, SentForSignature, NotSet, etc." }, { "key": "skip", "value": "", "description": "Zero-based offset for paging - number of documents to skip before returning results. Must be non-negative." }, { "key": "take", "value": "", "description": "Page size - maximum number of documents to return. Defaults to 10, capped at 100." }, { "key": "sortField", "value": "", "description": "Field name to sort the result set by. Defaults to \u0022RequestNumber\u0022." }, { "key": "order", "value": "", "description": "Sort direction, \u0022asc\u0022 or \u0022desc\u0022. Defaults to \u0022desc\u0022." }, { "key": "query", "value": "", "description": "Free-text search term applied to request number, template name, or other fields." }, { "key": "excludeParentRelationships", "value": "", "description": "If true, excludes parent relationships from the result." }, { "key": "excludedDocuments", "value": "", "description": "Document IDs to omit from results - typically used to hide already-selected items. Comma separated GUIDs." }, { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } } ] }, { "name": "Ask Legal", "item": [ { "name": "Submit Ask Legal answers", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/asklegal/:pendingRequestId/answers", "host": [ "{{baseUrl}}" ], "path": [ "requests", "asklegal", ":pendingRequestId", "answers" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022questionsAnswers\u0022: [\r\n {\r\n \u0022questionId\u0022: \u0022\\u003CquestionId\\u003E\u0022,\r\n \u0022answer\u0022: \u0022\u0022\r\n }\r\n ],\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit answers to the template questions for a pending Ask Legal request. Call this after initialising the request with the pendingRequestId returned from the Initialise step." } }, { "name": "Upload attachment for Ask Legal", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/asklegal/:pendingRequestId/attachment", "host": [ "{{baseUrl}}" ], "path": [ "requests", "asklegal", ":pendingRequestId", "attachment" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload a supporting attachment for a pending Ask Legal request. Attachments are optional and can be added at any point before processing." } }, { "name": "Initialise an Ask Legal request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/asklegal", "host": [ "{{baseUrl}}" ], "path": [ "requests", "asklegal" ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022templateId\u0022: \u0022\\u003CtemplateId\\u003E\u0022,\r\n \u0022requestName\u0022: \u0022\u0022,\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Start a new Ask Legal request. Returns a pendingRequestId used in all subsequent steps. Typical flow: Initialise \u2192 Answers \u2192 Attachment (optional) \u2192 Process." } }, { "name": "Process an Ask Legal request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/asklegal/:pendingRequestId/process", "host": [ "{{baseUrl}}" ], "path": [ "requests", "asklegal", ":pendingRequestId", "process" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit the completed Ask Legal request for processing. This is the final step \u2014 once processed, the request cannot be modified. Use the Status endpoint to track progress after processing." } } ] }, { "name": "Create", "item": [ { "name": "Submit answers for Create Request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/create/:pendingRequestId/answers", "host": [ "{{baseUrl}}" ], "path": [ "requests", "create", ":pendingRequestId", "answers" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022,\r\n \u0022questionsAnswers\u0022: [\r\n {\r\n \u0022questionId\u0022: \u0022\\u003CquestionId\\u003E\u0022,\r\n \u0022answer\u0022: \u0022\u0022\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit answers to the template questions for a pending Create Request. Call this after initialising the request with the pendingRequestId returned from the Initialise step." } }, { "name": "Initialise a Create Request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/create", "host": [ "{{baseUrl}}" ], "path": [ "requests", "create" ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022templateId\u0022: \u0022\\u003CtemplateId\\u003E\u0022,\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022,\r\n \u0022requestName\u0022: \u0022\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Start a new Create Request to generate a document from a template. Returns a pendingRequestId used in all subsequent steps. Typical flow: Initialise \u2192 Answers \u2192 Fields \u2192 Process." } }, { "name": "Get field values for Create request", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/requests/create/:pendingRequestId/fields", "host": [ "{{baseUrl}}" ], "path": [ "requests", "create", ":pendingRequestId", "fields" ], "variable": [ { "key": "pendingRequestId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] }, "description": "Retrieve the field definitions available for the template and the current values set on a pending Create request. Use this to see which fields the template exposes and which have been set before processing." } }, { "name": "Set fields Create Request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/create/:pendingRequestId/fields", "host": [ "{{baseUrl}}" ], "path": [ "requests", "create", ":pendingRequestId", "fields" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022,\r\n \u0022fields\u0022: [\r\n {\r\n \u0022id\u0022: \u0022\u0022,\r\n \u0022type\u0022: \u0022\u0022,\r\n \u0022value\u0022: {\r\n \u0022valueKind\u0022: \u0022...\u0022\r\n }\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Set field values on a pending Create Request. Fields can be updated multiple times before the request is processed." } }, { "name": "Process a Create Request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/create/:pendingRequestId/process", "host": [ "{{baseUrl}}" ], "path": [ "requests", "create", ":pendingRequestId", "process" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit the completed Create request for processing. This is the final step \u2014 once processed, the request cannot be modified. Use the Status endpoint to track progress after processing." } } ] }, { "name": "Documents", "item": [ { "name": "Get Documents By Reference", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/requests/documents/reference/:externalReferenceId", "host": [ "{{baseUrl}}" ], "path": [ "requests", "documents", "reference", ":externalReferenceId" ], "variable": [ { "key": "externalReferenceId", "value": "" } ] } } } ] }, { "name": "Repository", "item": [ { "name": "Upload attachment for Repository", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/manage/:pendingRequestId/attachment", "host": [ "{{baseUrl}}" ], "path": [ "requests", "manage", ":pendingRequestId", "attachment" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload a supporting attachment for a pending Repository request. Attachments are optional and can be added at any point before processing." } }, { "name": "Initialise a Repository request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/manage", "host": [ "{{baseUrl}}" ], "path": [ "requests", "manage" ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022clientId\u0022: \u0022\\u003CclientId\\u003E\u0022,\r\n \u0022matterId\u0022: \u0022\\u003CmatterId\\u003E\u0022,\r\n \u0022documentTypeId\u0022: \u0022\\u003CdocumentTypeId\\u003E\u0022,\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Start a new Repository request to add an existing document to the repository. Returns a pendingRequestId used in all subsequent steps. Typical flow: Initialise \u2192 Main Document \u2192 Linked Documents (optional) \u2192 Attachments (optional) \u2192 Process." } }, { "name": "Upload linked document for Repository", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/manage/:pendingRequestId/linkedDocument", "host": [ "{{baseUrl}}" ], "path": [ "requests", "manage", ":pendingRequestId", "linkedDocument" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload a linked document (e.g. variation, addendum) for a pending Repository request. Multiple linked documents can be uploaded before processing." } }, { "name": "Upload main document for Repository", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/manage/:pendingRequestId/masterDocument", "host": [ "{{baseUrl}}" ], "path": [ "requests", "manage", ":pendingRequestId", "masterDocument" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload the main document (the primary contract file) for a pending Repository request. This is typically the first upload step after initialisation." } }, { "name": "Process a Repository request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/manage/:pendingRequestId/process", "host": [ "{{baseUrl}}" ], "path": [ "requests", "manage", ":pendingRequestId", "process" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit the completed Repository request for processing. This is the final step \u2014 once processed, the request cannot be modified. Use the Status endpoint to track progress after processing." } } ] }, { "name": "New Version", "item": [ { "name": "Upload document for new version for Create", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/create/newversion/:pendingRequestId/document", "host": [ "{{baseUrl}}" ], "path": [ "requests", "create", "newversion", ":pendingRequestId", "document" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload the generated document for a pending new version Create request. Call this after initialisation and before processing." } }, { "name": "Initialise a new version for Create", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/create/:documentId/newversion", "host": [ "{{baseUrl}}" ], "path": [ "requests", "create", ":documentId", "newversion" ], "variable": [ { "key": "documentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Start a new version of an existing document using the Create workflow. Returns a pendingRequestId used in all subsequent steps. Typical flow: Initialise \u2192 Document \u2192 Process." } }, { "name": "Process a new version for Create", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/create/newversion/:pendingRequestId/process", "host": [ "{{baseUrl}}" ], "path": [ "requests", "create", "newversion", ":pendingRequestId", "process" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit the completed new version Create request for processing. This is the final step \u2014 once processed, the request cannot be modified." } }, { "name": "Initialise a new version for Repository", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/manage/:documentId/newversion", "host": [ "{{baseUrl}}" ], "path": [ "requests", "manage", ":documentId", "newversion" ], "variable": [ { "key": "documentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Start a new version of an existing document using the Repository workflow. Returns a pendingRequestId used in all subsequent steps. The main document and linked documents are both optional \u2014 upload only those that are changing for the new version. Typical flow: Initialise \u2192 Main Document (optional) \u2192 Linked Documents (optional) \u2192 Process." } }, { "name": "Delete linked document from new version Repository", "request": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/requests/manage/newversion/:pendingRequestId/linkedDocument/:linkedDocumentId", "host": [ "{{baseUrl}}" ], "path": [ "requests", "manage", "newversion", ":pendingRequestId", "linkedDocument", ":linkedDocumentId" ], "variable": [ { "key": "pendingRequestId", "value": "" }, { "key": "linkedDocumentId", "value": "" } ] }, "description": "Remove a previously uploaded linked document from a pending new version Repository request." } }, { "name": "Replace linked document for new version for Repository", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/manage/newversion/:pendingRequestId/linkedDocument/:linkedDocumentId", "host": [ "{{baseUrl}}" ], "path": [ "requests", "manage", "newversion", ":pendingRequestId", "linkedDocument", ":linkedDocumentId" ], "variable": [ { "key": "pendingRequestId", "value": "" }, { "key": "linkedDocumentId", "value": "" } ] }, "description": "Replace an existing linked document on a pending new version Repository request with an updated file." } }, { "name": "Upload linked document for new version for Repository", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/manage/newversion/:pendingRequestId/linkedDocument", "host": [ "{{baseUrl}}" ], "path": [ "requests", "manage", "newversion", ":pendingRequestId", "linkedDocument" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload a linked document (e.g. variation, addendum) for a pending new version Repository request. Multiple linked documents can be uploaded before processing." } }, { "name": "Upload main document for new version for Repository", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/manage/newversion/:pendingRequestId/masterDocument", "host": [ "{{baseUrl}}" ], "path": [ "requests", "manage", "newversion", ":pendingRequestId", "masterDocument" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload the main document (the primary contract file) for a pending new version Repository request. This is typically the first upload step after initialisation." } }, { "name": "Process a new version for Repository", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/manage/newversion/:pendingRequestId/process", "host": [ "{{baseUrl}}" ], "path": [ "requests", "manage", "newversion", ":pendingRequestId", "process" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit the completed new version Repository request for processing. This is the final step \u2014 once processed, the request cannot be modified." } }, { "name": "Initialise a new version for Review", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/review/:documentId/newversion", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review", ":documentId", "newversion" ], "variable": [ { "key": "documentId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Start a new version of an existing document using the Review workflow. Returns a pendingRequestId used in all subsequent steps. The main document and linked documents are both optional \u2014 upload only those that are changing for the new version. Typical flow: Initialise \u2192 Main Document (optional) \u2192 Linked Documents (optional) \u2192 Process." } }, { "name": "Delete linked document from new version for Review", "request": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/requests/review/newversion/:pendingRequestId/linkedDocument/:linkedDocumentId", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review", "newversion", ":pendingRequestId", "linkedDocument", ":linkedDocumentId" ], "variable": [ { "key": "pendingRequestId", "value": "" }, { "key": "linkedDocumentId", "value": "" } ] }, "description": "Remove a previously uploaded linked document from a pending new version Review request." } }, { "name": "Replace linked document for new version for Review", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/review/newversion/:pendingRequestId/linkedDocument/:linkedDocumentId", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review", "newversion", ":pendingRequestId", "linkedDocument", ":linkedDocumentId" ], "variable": [ { "key": "pendingRequestId", "value": "" }, { "key": "linkedDocumentId", "value": "" } ] }, "description": "Replace an existing linked document on a pending new version Review request with an updated file." } }, { "name": "Upload linked document for new version for Review", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/review/newversion/:pendingRequestId/linkedDocument", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review", "newversion", ":pendingRequestId", "linkedDocument" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload a linked document (e.g. variation, addendum) for a pending new version Review request. Multiple linked documents can be uploaded before processing." } }, { "name": "Upload main document for new version for Review", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/review/newversion/:pendingRequestId/masterDocument", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review", "newversion", ":pendingRequestId", "masterDocument" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload the main document (the primary contract file) for a pending new version Review request. This is typically the first upload step after initialisation." } }, { "name": "Process a new version for Review", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/review/newversion/:pendingRequestId/process", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review", "newversion", ":pendingRequestId", "process" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit the completed new version Review request for processing. This is the final step \u2014 once processed, the request cannot be modified." } }, { "name": "Get new version status", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/requests/newversion/:pendingRequestId/status", "host": [ "{{baseUrl}}" ], "path": [ "requests", "newversion", ":pendingRequestId", "status" ], "variable": [ { "key": "pendingRequestId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] }, "description": "Check the processing status of a new version request. Returns the current state and any errors encountered during processing." } } ] }, { "name": "Status", "item": [ { "name": "Get process status", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/requests/:pendingRequestId/process/status", "host": [ "{{baseUrl}}" ], "path": [ "requests", ":pendingRequestId", "process", "status" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] } } }, { "name": "Get request status", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/requests/:requestId/status", "host": [ "{{baseUrl}}" ], "path": [ "requests", ":requestId", "status" ], "variable": [ { "key": "requestId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } }, { "name": "Update request status", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/:requestId/status", "host": [ "{{baseUrl}}" ], "path": [ "requests", ":requestId", "status" ], "variable": [ { "key": "requestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022status\u0022: 0,\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Questions", "item": [ { "name": "Get questions for a template", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/requests/templates/:templateId/questions", "host": [ "{{baseUrl}}" ], "path": [ "requests", "templates", ":templateId", "questions" ], "variable": [ { "key": "templateId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } } ] }, { "name": "Review", "item": [ { "name": "Submit Review answers", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/review/:pendingRequestId/answers", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review", ":pendingRequestId", "answers" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022questionsAnswers\u0022: [\r\n {\r\n \u0022questionId\u0022: \u0022\\u003CquestionId\\u003E\u0022,\r\n \u0022answer\u0022: \u0022\u0022\r\n }\r\n ],\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit answers to the template questions for a pending Review request. Call this after initialising the request with the pendingRequestId returned from the Initialise step." } }, { "name": "Upload attachment for Review", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/review/:pendingRequestId/attachment", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review", ":pendingRequestId", "attachment" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload a supporting attachment for a pending Review request. Attachments are optional and can be added at any point before processing." } }, { "name": "Initialise a Review request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/review", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review" ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022templateId\u0022: \u0022\\u003CtemplateId\\u003E\u0022,\r\n \u0022requestName\u0022: \u0022\u0022,\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Start a new Review request to submit a document for review. Returns a pendingRequestId used in all subsequent steps. Typical flow: Initialise \u2192 Answers \u2192 Main Document \u2192 Linked Documents (optional) \u2192 Attachments (optional) \u2192 Process." } }, { "name": "Upload linked document for Review", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/review/:pendingRequestId/linkedDocument", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review", ":pendingRequestId", "linkedDocument" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload a linked document (e.g. variation, addendum) for a pending Review request. Multiple linked documents can be uploaded before processing." } }, { "name": "Upload main document for Review", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/requests/review/:pendingRequestId/masterDocument", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review", ":pendingRequestId", "masterDocument" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "description": "Upload the main document (the primary contract file) for a pending Review request. This is typically the first upload step after initialisation." } }, { "name": "Process a Review request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/requests/review/:pendingRequestId/process", "host": [ "{{baseUrl}}" ], "path": [ "requests", "review", ":pendingRequestId", "process" ], "variable": [ { "key": "pendingRequestId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\r\n \u0022requestorEmail\u0022: \u0022{{requestorEmail}}\u0022\r\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit the completed Review request for processing. This is the final step \u2014 once processed, the request cannot be modified. Use the Status endpoint to track progress after processing." } } ] }, { "name": "Templates", "item": [ { "name": "Get available templates", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/requests/templates", "host": [ "{{baseUrl}}" ], "path": [ "requests", "templates" ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] } } } ] } ] }, { "name": "Clause Manager", "description": "Manage contract types and their associated clauses.", "item": [ { "name": "Contract Types", "item": [ { "name": "Get contract type detail", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/clausemanager/contracttypes/:contractTypeId", "host": [ "{{baseUrl}}" ], "path": [ "clausemanager", "contracttypes", ":contractTypeId" ], "variable": [ { "key": "contractTypeId", "value": "" } ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] }, "description": "Retrieves a specific contract type with its clauses." } }, { "name": "Get contract types", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/clausemanager/contracttypes", "host": [ "{{baseUrl}}" ], "path": [ "clausemanager", "contracttypes" ], "query": [ { "key": "requestorEmail", "value": "{{requestorEmail}}", "description": "Email address of the user making the request. Used to verify the caller\u0027s access to the underlying record." } ] }, "description": "Retrieves all available contract types." } } ] } ] } ] }