For AI agents: the docs index is at https://developer.conga.com/contracts/llms.txt. The index for every project on this site is at https://developer.conga.com/llms.txt. Append .md to any documentation page URL to get its markdown version.

Home API Reference

Product Documentation Conga Community Log In

API Reference

Home API Reference

Contracts

Accounts
- Get contract hierarchy for an account using querypost
- Get hierarchy starting from a specific contract under an accountpost
Contract Type Document Requirement Settings
Conversation Thread
- Get thread recordspost
- Search conversation threadspost
Obligations
- Get activated contracts with obligationspost
Review Group
Sign
- End wet signature flowpost
Template
- Find template recordspost
ActivityHistory
- Get activity history recordspost
- Get the activity feed for the current user's contractspost
Bulk Import
Clause Obligations
Configurations
- Get configurationget
Contract
Contract Clause
Contract Cycle Time
Contract Documents
Contract Lifecycle
Contract Obligations
Contract Obligations Fulfillment
Contract Related List
Contract Relationship
Contract Request
Contract Request Team Members
Contract Team Members
Document Generation
Document Settings
Contract Obligations Fulfillment
Contract Related List
- Update multiple object recordsput
Export
- Export query results to Excel/CSVpost
- Export search results to Excel/CSVpost
In-Effect View
Review
Team Role

Review

Authorization
HealthCheck
Review
ReviewCycleGroup
Reviewer
ReviewSites
- Validate Sharepoint siteget
User
- Search usersget
- Gets existing users from search textget

X-Author

AgreementAccess
- Check which users have access to an agreement record.get
- Grant access to an agreement record for the specified users.post
Search
- Searches the specified entity type by name prefix.get
Obligation
- Get obligation details by obligation IDs.post
ConfigurationManagement
- Toggle connect to CRM flagput
DiscoveryAI
- Extracts and returns a marked-up document for review.post
FeatureSettings
GoogleConfig
- Gets the information of google drive support and service account configurations in clmget
Layout
- Retrieves the page field definitions and configuration metadata for the specified layout.get
AgreementObligation
- Get all Obligations linked to a specific agreement.get
Reconciliation
- Process document to prepare data for reconciliation previewpost
- /api/xauthor/v1/reconcile/preview-data/sametagfieldspost
Playbook
PlaybookExecution
- Executes the specified playbook with the provided input document and returns the execution details.post
- Retrieves the playbook execution results including clause rule and document rule outcomes.post
RedlineExecutionStatus
- s Retrieves the current execution status of a redline operation, including extraction and redlining progress.get
RedlineHistoricalResults
- Retrieves historical precedent results for the specified execution. Optionally filters results by a comma-separated list of rule IDs.get
RuleExecution
DataCorrection
- Convert RecordType to ContractTypeput
Analytics
- Add application usage datapost
Log
- Applications exception logging.post
- To Log the custom metrics for the XA userpost
SchemaMetadata
- Retrieves the entities.post
ClauseMetadata
- Get a template clause's metadataget
- Get mark clause metadataget
PackageMigration
- Export packagepost
- Import packagepost
TemplateMigrate
- Export a templatepost
- Import a templatepost
AgreementMetadata
- Get fieldsget
AgreementReview
- /api/xauthor/v1/contracts/{contractId}/reviewsget
AdminSettings
- Get administrator settingsget
- Get Google account configurationget
Agreement
AIRedline
Document
DocumentMetadata
DocumentProtection
DocumentReview
- Check Send For Review status.get
- Check review cycle is pending or not.get
DocumentSync
Account
- Get accountsget
Authorization
- Get token informationget
Contact
- Get contactsget
Encryption
- Encrypt provided textpost
Query
- Retrieve dynamic lookup datapost
RecordType
- Retrieve record typeget
AlternateClause
ClauseComparison
ClauseContent
Clause
ClauseLibrary
ClauseVersion
- Get clause content as text or HTMLget
AgreementClause
AgreementDocumentCheckin
- Check in a document specific to an agreementpost
AgreementDocument
AgreementLock
AgreementOffline
AgreementTemplate
- Get a template for an agreementget
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 checkinpost
DAI
- Get IDE job statusget
- Extract and mark the clauses and fields in the request document and also update the metadatapost
FieldData
- Get Locale Based Formatted Field Valuespost
FieldDataRetrieval
- Get field data with locale based formatted valuespost
FieldMark
- Mark as fieldpost
- Mark as fieldpost
Fields
FieldsValidate
- Validates the fields in a document for a given object and field API name.post
IntelligentImport
IntelligentImportRisk
Token
UFC
- Get repeat and section datapost
- Update repeat and section datapost
User
- /api/xajs/v1/xAuthor/User/UsersByTypepost
- get logged in user infoget

Searches the specified entity type by name prefix.

get

https://rls.congacloud.com/api/xauthor/v1/search/parties/{type}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

type

string | null

required

Entity type to search. Accepted values: User, UserGroup, Contact, SupplierContact.

Query Params

searchText

string | null

Partial name text used to filter results.

Headers

OrgType

string

required

Defaults to RLP

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Bad Request

401

Unauthorized

404

Not Found

500

Server Error

Updated about 3 hours ago

Grant access to an agreement record for the specified users.

Obligation

Did this page help you?

Language

Credentials

Client

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

Updated about 3 hours ago

Grant access to an agreement record for the specified users.

Obligation

Did this page help you?

200Success