{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:ironclad/workflows-list-all":{"get":{"operationId":"business_ironclad_workflows_list_all","summary":"List All Workflows","description":"GET /workflows","tags":["business"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number used when paginating through a list of results.","schema":{"type":"integer","default":0,"description":"The page number used when paginating through a list of results."}},{"name":"pageSize","in":"query","required":false,"description":"A limit of the number of results to return.","schema":{"type":"integer","default":20,"description":"A limit of the number of results to return."}},{"name":"status","in":"query","required":false,"description":"Filter the workflows that are listed based on their status. If this parameter is omitted, `active` workflows will be returned. Active…","schema":{"type":"string","enum":["active","paused","completed","cancelled"],"description":"Filter the workflows that are listed based on their status. If this parameter is omitted, `active` workflows will be returned. Active…"}},{"name":"template","in":"query","required":false,"description":"Filter workflows to a specific Template ID.","schema":{"type":"string","description":"Filter workflows to a specific Template ID."}},{"name":"lastUpdated","in":"query","required":false,"description":"Retrieve workflows that have been updated since a UTC date.","schema":{"type":"string","description":"Retrieve workflows that have been updated since a UTC date."}},{"name":"filter","in":"query","required":false,"description":"Filter workflows using a formula. The workflow attribute ID should be enclosed in brackets `[ ]` and the value should be enclosed in…","schema":{"type":"string","description":"Filter workflows using a formula. The workflow attribute ID should be enclosed in brackets `[ ]` and the value should be enclosed in…"},"example":"Equals([counterpartyName], 'Harley Quinn')"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-create-sync-workflow":{"post":{"operationId":"business_ironclad_workflows_create_sync_workflow","summary":"Create a Workflow Synchronously","description":"POST /workflows","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-launch-asynchronously":{"post":{"operationId":"business_ironclad_workflows_launch_asynchronously","summary":"Create a Workflow Asynchronously","description":"POST /workflows/async","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-get-async-job-status":{"get":{"operationId":"business_ironclad_workflows_get_async_job_status","summary":"Retrieve the Status of an Async Workflow Create Job","description":"GET /workflows/async/{asyncJobId}","tags":["business"],"parameters":[{"name":"asyncJobId","in":"query","required":true,"description":"The identifier provided in the response of creating a Workflow asynchronously.","schema":{"type":"string","description":"The identifier provided in the response of creating a Workflow asynchronously."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-get-workflow":{"get":{"operationId":"business_ironclad_workflows_get_workflow","summary":"Retrieve a Workflow","description":"GET /workflows/{id}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier or Ironclad ID of a workflow.","schema":{"type":"string","description":"The unique identifier or Ironclad ID of a workflow."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-list-approvals":{"get":{"operationId":"business_ironclad_workflows_list_approvals","summary":"List All Workflow Approvals","description":"GET /workflows/{id}/approvals","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier or Ironclad ID of a workflow.","schema":{"type":"string","description":"The unique identifier or Ironclad ID of a workflow."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-get-approval-requests":{"get":{"operationId":"business_ironclad_workflows_get_approval_requests","summary":"Retrieve the Approval Requests on a Workflow","description":"GET /workflows/{id}/approval-requests","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier or Ironclad ID of a workflow.","schema":{"type":"string","description":"The unique identifier or Ironclad ID of a workflow."}},{"name":"page","in":"query","required":false,"description":"The page number used when paginating through a list of results.","schema":{"type":"integer","default":0,"description":"The page number used when paginating through a list of results."}},{"name":"pageSize","in":"query","required":false,"description":"A limit of the number of results to return.","schema":{"type":"integer","default":20,"description":"A limit of the number of results to return."}},{"name":"actorDetails","in":"query","required":false,"description":"An optional boolean parameter that adds additional information about the actor to each item in the response. Defaults to false.","schema":{"type":"boolean","default":false,"description":"An optional boolean parameter that adds additional information about the actor to each item in the response. Defaults to false."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-update-approval-status":{"post":{"operationId":"business_ironclad_workflows_update_approval_status","summary":"Update Approval on a Workflow","description":"PATCH /workflows/{id}/approvals/{roleId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","roleId"],"properties":{"id":{"type":"string","description":"The unique identifier or Ironclad ID of a workflow."},"roleId":{"type":"string","description":"The unique identifier of the approver role whose status should be changed. This identifier can be retrieved using the `GET…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-get-turn-history":{"get":{"operationId":"business_ironclad_workflows_get_turn_history","summary":"Retrieve the Turn History on a Workflow","description":"GET /workflows/{id}/turn-history","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier or Ironclad ID of a workflow.","schema":{"type":"string","description":"The unique identifier or Ironclad ID of a workflow."}},{"name":"page","in":"query","required":false,"description":"The page number used when paginating through a list of results.","schema":{"type":"integer","default":0,"description":"The page number used when paginating through a list of results."}},{"name":"pageSize","in":"query","required":false,"description":"A limit of the number of results to return.","schema":{"type":"integer","default":20,"description":"A limit of the number of results to return."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-list-signatures":{"get":{"operationId":"business_ironclad_workflows_list_signatures","summary":"List All Workflow Signers","description":"GET /workflows/{id}/signatures","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier or Ironclad ID of a workflow.","schema":{"type":"string","description":"The unique identifier or Ironclad ID of a workflow."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-list-all-participants":{"get":{"operationId":"business_ironclad_workflows_list_all_participants","summary":"List All Workflow Participants","description":"GET /workflows/{id}/participants","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier or Ironclad ID of a workflow.","schema":{"type":"string","description":"The unique identifier or Ironclad ID of a workflow."}},{"name":"page","in":"query","required":false,"description":"The page number used when paginating through a list of results.","schema":{"type":"integer","default":0,"description":"The page number used when paginating through a list of results."}},{"name":"pageSize","in":"query","required":false,"description":"A limit of the number of results to return.","schema":{"type":"integer","default":20,"description":"A limit of the number of results to return."}},{"name":"email","in":"query","required":false,"description":"The Ironclad user's email address.","schema":{"type":"string","description":"The Ironclad user's email address."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-revert-to-review":{"post":{"operationId":"business_ironclad_workflows_revert_to_review","summary":"Revert a Workflow to the Review Step","description":"PATCH /workflows/{id}/revert-to-review","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier or Ironclad ID of a workflow."},"x-as-user-email":{"type":"string","description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user email. Permissions can be…"},"x-as-user-id":{"type":"string","description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user id. Permissions can be launch,…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-create-comment":{"post":{"operationId":"business_ironclad_workflows_create_comment","summary":"Create a Comment on a Workflow","description":"POST /workflows/{id}/comments","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier or Ironclad ID of a workflow."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-update-metadata":{"post":{"operationId":"business_ironclad_workflows_update_metadata","summary":"Update Workflow Metadata","description":"PATCH /workflows/{id}/attributes","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier or Ironclad ID of a workflow."},"x-as-user-email":{"type":"string","description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user email. Permissions can be…"},"x-as-user-id":{"type":"string","description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user id. Permissions can be launch,…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-get-document-by-key":{"get":{"operationId":"business_ironclad_workflows_get_document_by_key","summary":"Retrieve a Workflow Document","description":"GET /workflows/{id}/document/{key}/download","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier or Ironclad ID of a workflow.","schema":{"type":"string","description":"The unique identifier or Ironclad ID of a workflow."}},{"name":"key","in":"query","required":true,"description":"The unique identifier for the attachment. This key can be located using the [Retrieve a…","schema":{"type":"string","description":"The unique identifier for the attachment. This key can be located using the [Retrieve a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-get-email-threads":{"get":{"operationId":"business_ironclad_workflows_get_email_threads","summary":"Retrieve Email Threads from A Workflow","description":"GET /workflows/{id}/emails","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of a workflow","schema":{"type":"string","description":"The unique identifier of a workflow"}},{"name":"page","in":"query","required":false,"description":"The page number used when paginating through a list of results.","schema":{"type":"integer","default":0,"description":"The page number used when paginating through a list of results."}},{"name":"pageSize","in":"query","required":false,"description":"A limit of the number of results to return.","schema":{"type":"integer","default":20,"description":"A limit of the number of results to return."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-get-email-thread":{"get":{"operationId":"business_ironclad_workflows_get_email_thread","summary":"Retrieve an Email Thread from a Specified Workflow","description":"GET /workflows/{id}/emails/{emailThreadId}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of a workflow","schema":{"type":"string","description":"The unique identifier of a workflow"}},{"name":"emailThreadId","in":"query","required":true,"description":"The unique identifier of an email thread","schema":{"type":"string","description":"The unique identifier of an email thread"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-get-attachment-from-email-thread":{"get":{"operationId":"business_ironclad_workflows_get_attachment_from_email_thread","summary":"Retrieve an Attachment from an Email Thread","description":"GET /workflows/{id}/emails/{emailThreadId}/attachments/{attachmentId}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of a workflow","schema":{"type":"string","description":"The unique identifier of a workflow"}},{"name":"emailThreadId","in":"query","required":true,"description":"The unique identifier of an email thread","schema":{"type":"string","description":"The unique identifier of an email thread"}},{"name":"attachmentId","in":"query","required":true,"description":"The unique identifier for the attachment. This key can be located using the [Retrieve email threads from…","schema":{"type":"string","description":"The unique identifier for the attachment. This key can be located using the [Retrieve email threads from…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-list-all-workflow-schemas":{"get":{"operationId":"business_ironclad_workflows_list_all_workflow_schemas","summary":"List All Workflow Schemas","description":"GET /workflow-schemas","tags":["business"],"parameters":[{"name":"form","in":"query","required":true,"description":"The launch form is the only form supported at this time.","schema":{"type":"string","default":"launch","description":"The launch form is the only form supported at this time."}},{"name":"x-as-user-email","in":"query","required":false,"description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user email. Permissions can be…","schema":{"type":"string","description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user email. Permissions can be…"}},{"name":"x-as-user-id","in":"query","required":false,"description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user id. Permissions can be launch,…","schema":{"type":"string","description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user id. Permissions can be launch,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/workflows-get-workflow-schema":{"get":{"operationId":"business_ironclad_workflows_get_workflow_schema","summary":"Retrieve a Workflow Schema","description":"GET /workflow-schemas/{id}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of a schema (see explanation of [Template ID](https://developer.ironcladapp.com/reference/getting-started-api)). A…","schema":{"type":"string","description":"The unique identifier of a schema (see explanation of [Template ID](https://developer.ironcladapp.com/reference/getting-started-api)). A…"}},{"name":"form","in":"query","required":false,"schema":{"type":"string","default":"launch"}},{"name":"x-as-user-email","in":"query","required":false,"description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user email. Permissions can be…","schema":{"type":"string","description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user email. Permissions can be…"}},{"name":"x-as-user-id","in":"query","required":false,"description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user id. Permissions can be launch,…","schema":{"type":"string","description":"Filters the list of workflow schemas based on the permissions of a user associated with the specified user id. Permissions can be launch,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-list-all":{"get":{"operationId":"business_ironclad_records_list_all","summary":"List All Records","description":"GET /records","tags":["business"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number used when paginating through a list of results.","schema":{"type":"integer","default":0,"description":"The page number used when paginating through a list of results."}},{"name":"pageSize","in":"query","required":false,"description":"A limit of the number of results to return.","schema":{"type":"integer","default":20,"description":"A limit of the number of results to return."}},{"name":"types","in":"query","required":false,"description":"Comma separated (no spaces) record types to export. Use the [Retrieve Records…","schema":{"type":"string","description":"Comma separated (no spaces) record types to export. Use the [Retrieve Records…"},"example":"mutualNDA,consultingAgreement"},{"name":"lastUpdated","in":"query","required":false,"description":"Get records updated since (UTC)","schema":{"type":"string","description":"Get records updated since (UTC)"},"example":"2018-03-10T00:00:00.000Z"},{"name":"filter","in":"query","required":false,"description":"Filter records for those that contain (1) the specified property with (2) the specified value. The record property ID should be enclosed…","schema":{"type":"string","description":"Filter records for those that contain (1) the specified property with (2) the specified value. The record property ID should be enclosed…"}},{"name":"sortField","in":"query","required":false,"description":"The field to sort Records. Only one field is supported in the sort operation.","schema":{"type":"string","enum":["agreementDate","name","lastUpdated"],"default":"agreementDate","description":"The field to sort Records. Only one field is supported in the sort operation."}},{"name":"sortDirection","in":"query","required":false,"description":"The direction the records are sorted by in correlation with the `sortField`.","schema":{"type":"string","enum":["ASC","DESC"],"default":"DESC","description":"The direction the records are sorted by in correlation with the `sortField`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-create-record":{"post":{"operationId":"business_ironclad_records_create_record","summary":"Create a Record","description":"POST /records","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-get-predictions":{"get":{"operationId":"business_ironclad_records_get_predictions","summary":"Retrieve Predictions","description":"GET /records/smart-import","tags":["business"],"parameters":[{"name":"recordId","in":"query","required":false,"description":"The ID of the Record for prediction status.","schema":{"type":"string","description":"The ID of the Record for prediction status."}},{"name":"importId","in":"query","required":false,"description":"The ID of the Import for prediction statuses.","schema":{"type":"string","description":"The ID of the Import for prediction statuses."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-upload-smart-import-record":{"post":{"operationId":"business_ironclad_records_upload_smart_import_record","summary":"Create a Smart Import Record","description":"POST /records/smart-import","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-upload-smart-import-record-with-predictions":{"post":{"operationId":"business_ironclad_records_upload_smart_import_record_with_predictions","summary":"Upload a Smart Import Record to an existing Import","description":"POST /records/smart-import/{importId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["importId"],"properties":{"importId":{"type":"string","description":"The Import Id. You can upload a record to an existing import in the repository."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-get-record-data":{"get":{"operationId":"business_ironclad_records_get_record_data","summary":"Retrieve a Record","description":"GET /records/{id}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID or Ironclad ID of the Record.","schema":{"type":"string","description":"The ID or Ironclad ID of the Record."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-replace-metadata":{"post":{"operationId":"business_ironclad_records_replace_metadata","summary":"Replace a Record","description":"PUT /records/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID or Ironclad ID of the Record."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-update-metadata":{"post":{"operationId":"business_ironclad_records_update_metadata","summary":"Update Record Metadata","description":"PATCH /records/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID or Ironclad ID of the Record."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-delete-record":{"post":{"operationId":"business_ironclad_records_delete_record","summary":"Delete a Record","description":"DELETE /records/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID or Ironclad ID of the Record."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-get-schema":{"get":{"operationId":"business_ironclad_records_get_schema","summary":"Retrieve Records Schema","description":"GET /records/metadata","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-get-attachment":{"get":{"operationId":"business_ironclad_records_get_attachment","summary":"Retrieve an Attachment on a Record","description":"GET /records/{id}/attachments/{key}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID or Ironclad ID of the Record.","schema":{"type":"string","description":"The ID or Ironclad ID of the Record."}},{"name":"key","in":"query","required":true,"description":"The attachment key.","schema":{"type":"string","default":"signedCopy","description":"The attachment key."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-create-attachment":{"post":{"operationId":"business_ironclad_records_create_attachment","summary":"Create an Attachment on a Record","description":"POST /records/{id}/attachments/{key}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","key"],"properties":{"id":{"type":"string","description":"The ID or Ironclad ID of the Record. For an explanation of Record IDs or Ironclad IDs and how to find them, see [Getting…"},"key":{"type":"string","default":"signedCopy","description":"The attachment key. You can retrieve a list of available attachment keys with the [Retrieve Records…"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-remove-attachment":{"post":{"operationId":"business_ironclad_records_remove_attachment","summary":"Delete an Attachment on a Record","description":"DELETE /records/{id}/attachments/{key}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","key"],"properties":{"id":{"type":"string","description":"The ID or Ironclad ID of the Record."},"key":{"type":"string","default":"signedCopy","description":"The attachment key."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/records-get-xlsx-export-file":{"get":{"operationId":"business_ironclad_records_get_xlsx_export_file","summary":"Retrieve XLSX Export File of Records","description":"GET /records/export","tags":["business"],"parameters":[{"name":"types","in":"query","required":false,"description":"Comma separated list of record types to export. Example: `mutualNDA,NDA`","schema":{"type":"string","description":"Comma separated list of record types to export. Example: `mutualNDA,NDA`"}},{"name":"properties","in":"query","required":false,"description":"IDs of properties to export, comma separated. Example: `counterpartyName,agreementDate`","schema":{"type":"string","description":"IDs of properties to export, comma separated. Example: `counterpartyName,agreementDate`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/webhooks-list-all":{"get":{"operationId":"business_ironclad_webhooks_list_all","summary":"List All Webhooks","description":"GET /webhooks","tags":["business"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number used when paginating through a list of results.","schema":{"type":"integer","default":0,"description":"The page number used when paginating through a list of results."}},{"name":"pageSize","in":"query","required":false,"description":"A limit of the number of results to return.","schema":{"type":"integer","default":20,"description":"A limit of the number of results to return."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/webhooks-create-new":{"post":{"operationId":"business_ironclad_webhooks_create_new","summary":"Create a Webhook","description":"POST /webhooks","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/webhooks-get-data":{"get":{"operationId":"business_ironclad_webhooks_get_data","summary":"Retrieve a Webhook","description":"GET /webhooks/{id}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the webhook.","schema":{"type":"string","description":"The ID of the webhook."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:ironclad/webhooks-update-webhook-data":{"post":{"operationId":"business_ironclad_webhooks_update_webhook_data","summary":"Update a Webhook","description":"PATCH /webhooks/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the webhook."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/webhooks-delete-specific":{"post":{"operationId":"business_ironclad_webhooks_delete_specific","summary":"Delete a Webhook","description":"DELETE /webhooks/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the webhook."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:ironclad/webhooks-get-verification-key":{"get":{"operationId":"business_ironclad_webhooks_get_verification_key","summary":"Retrieve Webhook Verification Key","description":"GET /webhooks/verification-key","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}