Conga Contract Documents API

openapi: 3.2.0
info:
  title: Contracts Contract Documents API
  version: v1
servers:
- url: https://rls.congacloud.com
- url: https://preview-rls09.congacloud.com
security:
- bearerAuth: []
tags:
- name: Contract Documents
paths:
  /api/clm/v1/contracts/createoffline:
    post:
      tags:
      - Contract Documents
      summary: Create an offline contract document
      description: 'Creates a new contract record based on an imported third-party contract document and attaches the original document to the new contract.


        On success, the contract status changes to "Author Contract".'
      requestBody:
        description: File binary data
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                documentAttributes:
                  type: object
                  additionalProperties: {}
                contract:
                  type: object
                  additionalProperties: {}
            example:
              Name: Reviewer
              Description: Team is responsible to review the associated contract
              Action:
              - SendForReview
              IsActive: true
            encoding:
              file:
                style: form
              documentAttributes:
                style: form
              contract:
                style: form
      responses:
        '200':
          description: Returns the newly created contract document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentMetadataAPIResponse'
        '400':
          description: The provided contract data or file data is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/createoffline/large:
    post:
      tags:
      - Contract Documents
      summary: Creates an offline contract and imports a large document linked to it.
      description: 'Creates a new contract record based on an imported third-party contract document and attaches the original document to the new contract.


        On success, the contract status changes to "Author Contract".'
      requestBody:
        description: "An object containing document-specific details, including the file name, file path of the large document and contract details required to create the contract.\n            to be imported."
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContractLargeDocumentRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ContractLargeDocumentRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ContractLargeDocumentRequest'
      responses:
        '200':
          description: Returns the newly created contract document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentMetadataAPIResponse'
        '400':
          description: The provided contract or file data is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/storeexecuted:
    post:
      tags:
      - Contract Documents
      summary: Create a contract from an executed contract
      description: 'Creates a new contract record from the provided executed contract document.


        On success, the contract status changes to "Activated".'
      requestBody:
        description: File binary data
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                documentAttributes:
                  type: object
                  additionalProperties: {}
                contract:
                  type: object
                  additionalProperties: {}
            example:
              Name: Reviewer
              Description: Team is responsible to review the associated contract
              Action:
              - SendForReview
              IsActive: true
            encoding:
              file:
                style: form
              documentAttributes:
                style: form
              contract:
                style: form
      responses:
        '200':
          description: Returns contract document details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentMetadataAPIResponse'
        '400':
          description: The provided contract data or file data is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/storeexecuted/large:
    post:
      tags:
      - Contract Documents
      summary: Store an executed large document.
      description: "Stores an executed large document for the specified contract ID. This operation allows the user to upload or reference \na document that is already uploaded to a filestore, and it links the document to the contract."
      requestBody:
        description: "An object containing document-specific details, including the file name and file path of the large document \n            to be stored."
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContractLargeDocumentRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ContractLargeDocumentRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ContractLargeDocumentRequest'
      responses:
        '200':
          description: Returns the newly created contract document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentMetadataAPIResponse'
        '400':
          description: The provided contract ID or file data is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/{contractId}/documents:
    delete:
      tags:
      - Contract Documents
      summary: Delete documents by contract ID
      description: Deletes one or more documents associated with a specific contract. You can provide a list of document IDs to delete specific documents, or omit the list to delete all documents linked to the contract. The API permanently removes the document data while retaining the metadata with the "IsDeleted" flag set to true. The API returns a confirmation of the deletion status.
      parameters:
      - name: contractId
        in: path
        description: ID of the contract
        required: true
        schema:
          type: string
      requestBody:
        description: List of Document IDs
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Returns confirmation that the document is deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BooleanAPIResponse'
              example:
                Success: true
                Data: true
                Warnings: null
                Errors: null
        '400':
          description: The provided contract ID or document ID is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
    post:
      tags:
      - Contract Documents
      summary: Create a new contract document
      description: "Creates a new contract document for the provided contract ID. \n\nOn success, the contract status changes to \"Author Contract\" if the contract's previous status was \"Request\"."
      parameters:
      - name: contractId
        in: path
        description: ID of the contract
        required: true
        schema:
          type: string
      requestBody:
        description: File binary data
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                documentAttributes:
                  type: object
                  additionalProperties: {}
            example:
              Name: Reviewer
              Description: Team is responsible to review the associated contract
              Action:
              - SendForReview
              IsActive: true
            encoding:
              file:
                style: form
              documentAttributes:
                style: form
      responses:
        '200':
          description: Returns the newly created contract document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentMetadataAPIResponse'
        '400':
          description: The provided contract ID or file data is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/{contractId}/documents/large:
    post:
      tags:
      - Contract Documents
      summary: Upload a large contract document
      description: "Uploads a large document to the specified contract ID.\nThis API allows you to reference a document that is already uploaded to the filestore and link it to the contract. \nProvide the file name, file path, and optional document attributes in the request payload."
      parameters:
      - name: contractId
        in: path
        description: ID of the contract
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LargeDocumentRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/LargeDocumentRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/LargeDocumentRequest'
      responses:
        '200':
          description: Returns the newly created contract document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentMetadataAPIResponse'
        '400':
          description: The provided contract ID or file data is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/{contractId}/documents/query:
    post:
      tags:
      - Contract Documents
      summary: Query contract documents
      description: Executes a query request against document records, returning matching records.
      parameters:
      - name: contractId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomQueryBase'
      responses:
        '200':
          description: Returns contract documents that match the provided query.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentSearchResponseAPIResponse'
        '400':
          description: The provided contract ID or query is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/{contractId}/documents/querywithreview:
    post:
      tags:
      - Contract Documents
      summary: Query contract documents for status and version
      description: Executes a query request against the document records and returns matching records with review status and document versions.
      parameters:
      - name: contractId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomQueryWithReviewStatus'
      responses:
        '200':
          description: Returns contract documents that match the provided query.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDocumentResponseAPIResponse'
        '400':
          description: The provided contract ID or query is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/{contractId}/documents/relateddocuments:
    get:
      tags:
      - Contract Documents
      summary: Get a contract's related documents
      description: Fetches all related documents for the provided contract ID.
      parameters:
      - name: contractId
        in: path
        description: ID of the contract
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the list of contract's related documents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractRelatedDocumentsResponseListAPIResponse'
        '400':
          description: The provided contract ID is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/{contractId}/documents/{documentId}:
    get:
      tags:
      - Contract Documents
      summary: Get document details
      description: Fetches document details for the provided document ID.
      parameters:
      - name: contractId
        in: path
        description: ID of the contract
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: ID of the document to be fetched
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns document details for the provided document ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentAPIResponse'
        '400':
          description: The provided contract ID or document ID is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
    put:
      tags:
      - Contract Documents
      summary: Update a contract
      description: "Updates the contract document for the provided document ID. \n\nThis API creates a new version ID with the same document ID and retains the previous version."
      parameters:
      - name: contractId
        in: path
        description: ID of the contract
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: ID of the document to be updated
        required: true
        schema:
          type: string
      - name: description
        in: query
        description: Description for the update
        schema:
          type: string
      requestBody:
        description: File binary data
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
            encoding:
              file:
                style: form
      responses:
        '200':
          description: Returns updated contract document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentMetadataAPIResponse'
        '400':
          description: The provided contract ID, document ID, or file data is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/{contractId}/documents/{documentId}/protect:
    post:
      tags:
      - Contract Documents
      summary: Protect a document
      description: 'Protects a document. This API takes a copy of the document with the provided document ID, applies the respective document protection based on the given action, and returns the copy.


        Document protection is applicable only for "DOCX" documents.'
      parameters:
      - name: contractId
        in: path
        description: ID of the contract
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: Document ID on which to apply protection
        required: true
        schema:
          type: string
      requestBody:
        description: Document action and user-selected protection level (if 'User Defined' option is configured).
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtectDocumentRequest'
      responses:
        '200':
          description: Returns the copy of protection applied document
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectDocumentResponseListAPIResponse'
        '400':
          description: Required values are not provided or provided values are invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/{contractId}/documents/{documentId}/versions:
    delete:
      tags:
      - Contract Documents
      summary: Delete document versions
      description: 'Deletes documents based on provided document version IDs for a specified contract ID.


        This API permanently deletes the document data but document metadata is retained in the system with the "IsDeleted" flag set to true.'
      parameters:
      - name: contractId
        in: path
        description: ID of the contract
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: ID of the document
        required: true
        schema:
          type: string
      requestBody:
        description: List of document versions
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Returns confirmation that the documents are deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BooleanAPIResponse'
              example:
                Success: true
                Data: true
                Warnings: null
                Errors: null
        '400':
          description: The provided contract ID, document ID, or version ID is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/{contractId}/documents/{documentId}/versions/{documentMetadataId}:
    get:
      tags:
      - Contract Documents
      summary: Get document by ID and version
      description: Fetches document details for the provided document ID and version ID.
      parameters:
      - name: contractId
        in: path
        description: ID of the contract
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: ID of the document to be fetched
        required: true
        schema:
          type: string
      - name: documentMetadataId
        in: path
        description: ID of the document version to be fetched
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns document details for the provided document ID and version ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentAPIResponse'
        '400':
          description: The provided contract ID, document ID, or version ID is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please contact admin.
  /api/clm/v1/contracts/{contractId}/importoffline:
    post:
      tags:
      - Contract Documents
      summary: Import an offline contract document
      description: "Creates a new contract document for the provided contract ID based on imported third-party paper.\n            \nOn success, the contract status changes to \"Author Contract\"."
      parameters:
      - name: contractId
        in: path
        description: ID of the contract
        required: true
        schema:
          type: string
      requestBody:
        description: File binary data
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                documentAttributes:
                  type: object
                  additionalProperties: {}
            example:
              Name: Reviewer
              Description: Team is responsible to review the associated contract
              Action:
              - SendForReview
              IsActive: true
            encoding:
              file:
                style: form
              documentAttributes:
                style: form
      responses:
        '200':
          description: Returns the newly created contract document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentMetadataAPIResponse'
        '400':
          description: The provided contract ID or file data is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Error Message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseError'
              example:
                Success: false
                Data: null
                Warnings: null
                Errors:
                - Id: null
                  Message: Internal server error occurred. Please con

# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-contract-documents-api-openapi.yml