Conga

Conga Agreement Lock API

This class contains API endpoints for Agreement Document's Lock.

GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/xauthor/v1/contracts/{contractId}/documents/lock-status Check whether an agreement document is locked · Get lock status #
Ask an LLM
“Is someone else currently editing this agreement document?”
“How can I tell if an agreement is locked before I check it out?”
Tell an agent
Check the lock status of agreement {contractId}.
Tell me who holds the edit lock on agreement {contractId}.
POST /api/xauthor/v1/contracts/{contractId}/documents/release-lock Release the edit lock on an agreement · Release an agreement lock #
Ask an LLM
“How do I unlock an agreement so others can edit it?”
“Can I release my lock on an agreement document when I'm done?”
Tell an agent
Release the lock on agreement {contractId}.
Unlock agreement {contractId} so someone else can check it out.
POST /api/xauthor/v1/contracts/{contractId}/documents/{documentid}/acquire-lock Lock an agreement document for editing · Lock an agreement #
Ask an LLM
“How do I lock an agreement document so nobody else edits it while I work?”
“Can I acquire an edit lock on one specific agreement document?”
Tell an agent
Lock document {documentid} on agreement {contractId} for my editing.
Acquire the edit lock for agreement {contractId}, document {documentid}.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-agreementlock-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conga:conga-agreementlock-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-agreementlock-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: X-Author Agreement Lock API
  version: v1
  description: This class contains API endpoints for Agreement Document's Lock.
servers:
- url: https://xauthor-prod-rls10.congacloud.com
- url: https://xauthor-preview-rls09.congacloud.com
security:
- bearerAuth: []
tags:
- name: AgreementLock
  description: This class contains API endpoints for Agreement Document's Lock.
paths:
  /api/xauthor/v1/contracts/{contractId}/documents/lock-status:
    post:
      tags:
      - AgreementLock
      summary: Get lock status
      description: When an agreement is open, it is locked by the specific user for editing and cannot be checked out by anyone else. This API gets the current lock status of the agreement based on the agreement ID provided in the parameters.
      parameters:
      - name: contractId
        in: path
        description: contractId
        required: true
        schema:
          type:
          - string
          - 'null'
          description: contractId
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      requestBody:
        description: The document lock parameters
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.DocumentLockParams'
          application/json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.DocumentLockParams'
          text/json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.DocumentLockParams'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.DocumentLockParams'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.LockStatus'
            application/json:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.LockStatus'
            text/json:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.LockStatus'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
      operationId: postApiXauthorV1ContractsByContractIdDocumentsLockStatus
      x-operation-id-source: derived
  /api/xauthor/v1/contracts/{contractId}/documents/release-lock:
    post:
      tags:
      - AgreementLock
      summary: Release an agreement lock
      description: Releases the agreement's lock based on the agreement ID provided in the parameters. After the lock is released, the user cannot edit the agreement or check it in.
      parameters:
      - name: contractId
        in: path
        description: contractId
        required: true
        schema:
          type:
          - string
          - 'null'
          description: contractId
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      requestBody:
        description: The document lock parameters
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.DocumentLockParams'
          application/json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.DocumentLockParams'
          text/json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.DocumentLockParams'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.DocumentLockParams'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.LockStatus'
            application/json:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.LockStatus'
            text/json:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.LockStatus'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
      operationId: postApiXauthorV1ContractsByContractIdDocumentsReleaseLock
      x-operation-id-source: derived
  /api/xauthor/v1/contracts/{contractId}/documents/{documentid}/acquire-lock:
    post:
      tags:
      - AgreementLock
      summary: Lock an agreement
      description: Locks the agreement identified in the parameters. With the lock acquired, the user can edit the agreement document and check it in.
      parameters:
      - name: contractId
        in: path
        description: contractId
        required: true
        schema:
          type:
          - string
          - 'null'
          description: contractId
      - name: documentid
        in: path
        description: Document id
        required: true
        schema:
          type:
          - string
          - 'null'
          description: Document id
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      requestBody:
        description: The document lock parameters
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.CheckOutRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.CheckOutRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.CheckOutRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.CheckOutRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.LockStatus'
            application/json:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.LockStatus'
            text/json:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.LockStatus'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
      operationId: postApiXauthorV1ContractsByContractIdDocumentsByDocumentidAcquireLock
      x-operation-id-source: derived
components:
  schemas:
    Apttus.XAuthor.Core.Model.CheckOutRequest:
      type: object
      properties:
        agreementVersion:
          type:
          - string
          - 'null'
        attachmentId:
          type:
          - string
          - 'null'
        protectionType:
          $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectionType'
      additionalProperties: false
    Apttus.XAuthor.Core.Model.ProtectionType:
      enum:
      - 0
      - 1
      - 2
      - 3
      - -1
      type: integer
      format: int32
    Apttus.XAuthor.Core.Model.LockStatus:
      type: object
      properties:
        isAgreementLocked:
          type: boolean
        lockedBy:
          type:
          - string
          - 'null'
        lockedDate:
          type:
          - string
          - 'null'
        isAgreementLockedByLoggedInUser:
          type: boolean
        agreementId:
          type:
          - string
          - 'null'
        attachmentId:
          type:
          - string
          - 'null'
        documentGuid:
          type:
          - string
          - 'null'
        agreementName:
          type:
          - string
          - 'null'
        agreementVersion:
          type:
          - string
          - 'null'
        agreementDocVersionId:
          type:
          - string
          - 'null'
        isDocumentUnderReview:
          type: boolean
        documentName:
          type:
          - string
          - 'null'
        auditLogProperties:
          type:
          - object
          - 'null'
          additionalProperties: {}
      additionalProperties: false
    Apttus.XAuthor.Core.Model.DocumentLockParams:
      type: object
      properties:
        agreementId:
          type:
          - string
          - 'null'
        agreementVersion:
          type:
          - string
          - 'null'
        attachmentId:
          type:
          - string
          - 'null'
        documentGuid:
          type:
          - string
          - 'null'
        agreementDocVersionId:
          type:
          - string
          - 'null'
        protectionType:
          $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectionType'
        templateId:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT