Jump to Content
Product Documentation
Conga Community
Home
API Reference
Product Documentation
Conga Community
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Home
API Reference
Retrieves the entities.
Search
JUMP TO
Contracts
Collaboration Message
Creates a new collaboration message within the specified collaboration thread.
post
Retrieves all collaboration messages for the specified collaboration thread.
post
Retrieves a collaboration message by its identifier.
get
Updates an existing collaboration message within the specified collaboration thread.
put
Obligations
Get activated contracts with obligations attached to them.
post
Sign
End wet signature flow
post
Template
Find template records
post
ActivityHistory
Get activity history records
post
Bulk Import
Create a bulk import job
post
List bulk import jobs
post
Get bulk import job result
get
Delete a bulk import job
del
Get uploaded file details
get
Get bulk import templates
get
Clause Obligations
Create a clause obligation request
post
Delete clause obligations
del
Get all clause obligations
post
Get a clause obligation by ID
get
Update a clause obligation
put
Delete a clause obligation by ID
del
Configurations
Get configuration
get
Contract
Create a contract record
post
Delete contracts
del
Update a contract record
put
Get a contract's details
get
Delete a contract
del
Update a contract's signature status
put
Get contract records
post
Contract Clause
Get contract clause details
get
Get all contract clauses
post
Creates a new contract clause
post
Updates an existing contract clause
put
Deletes a contract clause
del
Creates multiple contract clauses in a single operation
post
Updates multiple contract clauses in a single operation
put
Deletes multiple contract clauses in a single operation
del
Contract Cycle Time
Get a cycle-time group record by ID
get
Update a cycle-time group record
put
Delete a cycle-time group record
del
List all of a contract's or contract object's fields
get
Create a cycle-time group record
post
Get cycle-time group data
get
Contract Documents
Create a new contract document
post
Delete documents
del
Get document details
get
Update a contract
put
Query contract documents
post
Query contract documents for status and version
post
Get document by ID and version
get
Delete document versions
del
Get a contract's related documents
get
Import an offline contract document
post
Create an offline contract document
post
Create a contract from an executed contract
post
Import a large document.
post
Protect a document
post
Store an executed large document.
post
Creates an offline contract and imports a large document linked to it.
post
/api/clm/v1/contracts/{contractId}/documents/large
post
Contract Lifecycle
Activate a contract
post
Amend a contract
post
Renew a contract
post
Clone a contract
post
Terminate a contract
post
Expire a contract
post
Cancel a contract
post
Submit Request
post
Update contract status by lifecycle action
post
Contract Obligations
Create a contract obligation request
post
Delete contract obligations
del
Get all contract obligations
post
Get a contract obligation by ID
get
Update a contract obligation
put
Delete a contract obligation by ID
del
Create a contract obligation document
post
Get contract obligation document details
get
Delete a contract obligation document
del
Get the obligation and fulfillment details of the contract
post
Contract Obligations Fulfillment
Get a contract obligation fulfillment by ID
get
Update a contract obligation fulfillment by ID
put
Get Fulfillment history records
post
Perform an action on a contract obligation fulfillment
post
Contract Related List
Create records
post
Delete an object's records
del
Update an object's details
put
Get an object's details
get
Delete an object's details
del
Filter an object's records
post
Contract Relationship
Link contracts by relationship
post
Get contract relationship details
get
Unlink related contracts
del
Link contracts by relationship
post
Get hierarchy of a contract
get
Query a contract relationship
post
Contract Request
Get the contract request details
get
Update a contract request record
put
Delete a contract request
del
Create a contract request
post
Upload documents to a contract request
post
Delete documents
del
Get a contract request's related documents
get
Get contract request records
post
Convert a contract request to an agreement
post
Contract Team Members
Add team members to a contract and assign team role
post
Update a team member of a contract
put
Get a team member of a contract and associated responsibility
get
Remove a team member from a contract
del
Get team members of a contract by action
get
Get all team members of a contract
post
Document Generation
Generate a document
post
Regenerate a document
post
Generate a supporting document
post
Join documents
post
Preview a document
post
Document Settings
Create a document output format
post
Update document output format
put
Get a document output format
get
Delete a document output format
del
Show document output format records
post
Add a document protection setting
post
Update a document protection setting
put
Copy document protection settings
post
Get a document protection setting
get
Delete a document protection setting
del
Query document protection settings
post
Export
Export query results to Excel/CSV
post
Export search results to Excel/CSV
post
In-Effect View
Get in-effect view of contract detail changes
get
Get in-effect view of contract document changes
get
Get in-effect view of contract clause changes
get
Review
Initiate a review
post
Get review details
get
End a review
post
Cancel a review
post
Add reviewers
post
End review of reviewers
post
Remove reviewers
post
Search users
get
Get Active Directory access token
post
Team Role
/api/clm/v1/teamroles
post
Delete team roles
del
Update an existing team role
put
Get a team role by ID
get
Delete a team role
del
Query team role records
post
Review
Authorization
Get user profile authorization
get
Get an auth token for Google service account flow
post
Get an auth token for delegated flow
get
Review
Get review details
get
Cancel a review process
del
Get reviews
get
Send a document for review
post
End my review
post
Reviewer
Get reviewers
get
Add reviewers
post
Cancel a reviewer
del
End a reviewer's review
post
ReviewSites
Validate Sharepoint site
get
User
Search users
get
Gets existing users from search text
get
X-Author
ConfigurationManagement
Toggle connect to CRM flag
put
FeatureSettings
Get AI feature settings
get
Get external connection status
get
GoogleConfig
Gets the information of google drive support and service account configurations in clm
get
Layout
Retrieves the page field definitions and configuration metadata for the specified layout.
get
Reconciliation
Process document to prepare data for reconciliation preview
post
/api/xauthor/v1/reconcile/preview-data/sametagfields
post
DataCorrection
Convert RecordType to ContractType
put
Analytics
Add application usage data
post
Log
Applications exception logging.
post
To Log the custom metrics for the XA user
post
SchemaMetadata
Retrieves the entities.
post
ClauseMetadata
Get a template clause's metadata
get
Get mark clause metadata
get
PackageMigration
Export package
post
Import package
post
TemplateMigrate
Export a template
post
Import a template
post
AgreementMetadata
Get fields
get
AgreementReview
/api/xauthor/v1/contracts/{contractId}/reviews
get
AdminSettings
Get administrator settings
get
Get Google account configuration
get
Agreement
Get agreements
post
Get agreements owned by current logged in user
post
List recently viewed agreements
post
Get agreement details by contract
get
Get agreement record type
get
Create an agreement
post
AIRedline
This method is to process the check-in or publish of the document based on the AI suggestion and the details provided in the request.
post
This method to generate a preview of the updated contentbased on the AI suggestion and other details provided in the request
post
/api/xauthor/v1/contracts/{contractId}/AI/redline/risks/{attachmentId}
get
/api/xauthor/v1/contracts/{contractId}/AI/redline/risks
post
Document
Get document content by attachment
get
Get document content body
get
Get document or attachment by ID
get
Get the docx octet stream
get
Get file size in MB of the attachment by ID
get
Get document in Word online
post
Convert SDT elements to text
post
Get the name of a document file
post
Get content metadata
get
Get agreement details
post
Get document Clauses by attachment ID
get
DocumentMetadata
Get metadata and custom properties
get
Get document metadata
get
Get fields and clauses from document metadata
get
Get V2 metadata JSON
get
Get V2 metadata JSON
get
DocumentProtection
Remove document protection
post
Add document protection
post
Get the protection level of document.
get
Get the protection type of document.
get
DocumentReview
Check Send For Review status.
get
Check review cycle is pending or not.
get
DocumentSync
Sync the document.
post
Update the document Properties
post
Gets the attachment id by external id
get
Account
Get accounts
get
Authorization
Get token information
get
Contact
Get contacts
get
Encryption
Encrypt provided text
post
Query
Retrieve dynamic lookup data
post
RecordType
Retrieve record type
get
AlternateClause
Reorder alternate clauses
post
Link alternate clauses
post
Unlink alternate clauses
del
ClauseComparison
The Api is used to initiate the clause semantic comparison request
post
The API is used to get the comparison status on the basis of comparison id , it can give for multiple ids
get
The API is used to get the comparison status on the basis of comparison id
get
It returns the result after the semantic comparison is completed
get
ClauseContent
Mark plain text as a clause
post
Get clause content for document insertion
post
Get the markup clause details for both template and agreement in encoded format
post
Clause
List alternate clauses and sub-clauses
get
Get alternate clauses
post
Get a clause bundle
get
Validate alternate clauses
post
ClauseLibrary
Get clauses
post
Filter clauses
post
Promote a clause
post
ClauseVersion
Get clause content as text or HTML
get
AgreementClause
Create agreement clauses
post
Finalize a document's clause entries
post
Create agreement clauses as final
post
Create agreement clauses
post
Create original entries for the agreement clauses
post
AgreementDocumentCheckin
Check in a document specific to an agreement
post
AgreementDocument
Get agreement document versions
post
Regenerate an agreement document with the selected template
post
Compare and merge documents
post
Get agreement tags
get
AgreementLock
Get lock status
post
Release an agreement lock
post
Lock an agreement
post
AgreementOffline
Import an offline agreement
post
Create an offline agreement
post
Create offline Agreement
post
Import an offline agreement
post
Create store executed agreement
post
AgreementTemplate
Get a template for an agreement
get
ContractCheckin
Performs post checkin activity like reconcilation / pdf file creation / metadata processing. File content wont be read as part of this process.Request contains all the information related to file content which is required during checkin
post
DAI
Get IDE job status
get
Extract and mark the clauses and fields in the request document and also update the metadata
post
FieldData
Get Locale Based Formatted Field Values
post
FieldDataRetrieval
Get field data with locale based formatted values
post
FieldMark
Mark as field
post
Mark as field
post
Fields
Get field data
post
Retrieves the reference to field name.
post
Get fields data validation.
post
Get fields data validation for V2 metadata
post
Get Locale Based Formatted Field Values
post
IntelligentImport
Extract a document
post
Get document extraction status
get
Extract and mark the clauses and fields in the request document
post
Get the doc fields and clauses properties
post
IntelligentImportRisk
Get Risk Insights Data
post
Update Risk Insights Score
patch
Add Risk Insights Score
post
Get Risk Scale Data
get
Delete Risk Insights
post
Token
Get auth token
post
Validate Sharepoint site
get
Fetches the google authentication token for communicating with google APIs
get
UFC
Get repeat and section data
post
Update repeat and section data
post
User
get logged in user info
get
Powered by
Retrieves the entities.
post
https://xauthor-prod-rls10.congacloud.com/api/xauthor/v1/schema-metadata
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
Log in to use your API keys
URL
Base URL
https://xauthor-prod-rls10.congacloud.com
/api/xauthor/v1/schema-metadata
Response
Click
Try It!
to start a request and see the response here!