Skip to navigation

Get detailed information about agreement

View as Markdown

This operation retrieves detailed information about a specific agreement, identified by its unique id. The response provides a comprehensive view of the agreement, including its title, type, status, summary, and the full list of involved parties.

In addition to general details, the operation returns provisions that define the agreement’s legal, financial, lifecycle, and custom conditions. It also provides key metadata, such as creation and modification timestamps, related agreements, and user-defined or custom attributes, which help represent the structure and context of the agreement.

The operation is essential for retrieving the full context of an agreement, enabling users to understand the contract’s scope, key provisions, and the legal or financial obligations that have been agreed upon.

Use Cases:

  • Integrating agreement data into external systems: Sync detailed agreement information, such as legal and financial provisions, into external systems like ERP, CRM, or contract management tools to streamline workflows.
  • Providing detailed data for RAG (Retrieval-Augmented Generation) applications or Copilots: Retrieve detailed agreement data for use in LLM-based applications that answer specific user queries about their agreements, such as the status of a contract, its provisions, or involved parties.
  • Retrieving the complete details of a specific agreement: Use the full details of the agreement, including legal and financial provisions, for auditing, compliance, or review purposes.
  • Accessing agreement provisions for verification: Verify compliance with specific legal or financial terms of the agreement, ensuring that all parties are following the agreed-upon conditions.
  • Tracking agreement changes and history: Fetch metadata and related agreements to understand the evolution of an agreement, including modifications, associated agreements, and additional context provided by custom fields.
  • Reviewing user-defined or custom attributes: Examine custom fields or attributes to get more context about the agreement, particularly where the business has defined custom provisions or attributes.

Key Features:

  • Detailed Agreement Overview: Provides a comprehensive view of a specific agreement, including its title, type, status, summary, and more.
  • Provisions for Legal, Financial, and Lifecycle Conditions: Includes the full set of provisions that define the terms and conditions of the agreement, making it ideal for compliance and auditing purposes.
  • Metadata and History: Tracks the agreement’s history through metadata such as creation and modification dates and user-defined fields.
  • Data Source for AI Applications: Enables LLM-based applications to access granular agreement data, providing AI/ML-based solutions (such as Copilots) with the necessary context to answer detailed queries about an agreement.
  • Involved Parties and Related Agreements: Lists all parties involved and related agreements, allowing users to see all associated legal documents and relationships between agreements.

Authentication

AuthorizationBearer

Path parameters

accountIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"
agreementIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

Query parameters

include_linked_databooleanOptionalDefaults to false
Include linked data from external systems that correlate with this agreement.

Response

A JSON object containing details of the requested agreement document.
idstringformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"
The unique identifier for the agreement document.
titlestring or nullOptional
Title of the agreement document, summarizing its purpose.
file_namestring or nullOptional
The file name of the agreement.
document_idstring or nullOptionalRead-only
The id the original agreement document.
typestring or nullOptionalRead-only
The type of agreement.
categorystring or nullOptionalRead-only

Server-defined category based on the agreement type.

summarystring or nullOptionalRead-only<=135000 characters
A detailed summary of the agreement's key provisions and scope.
statusstring or nullOptionalRead-only

Current status of the agreement (e.g., PENDING, COMPLETE, INACTIVE)

review_statusstring or nullOptionalRead-only
The review status of the agreement, indicating whether it has been complete or pending.
review_completed_atstring or nullOptionalRead-onlyformat: "date-time"
The date when the agreement extraction review was completed.
partieslist of objects or nullOptionalRead-only
A list of parties involved in the agreement.
provisionsobjectOptional
"The conditions or rules written in a legal agreement. The set of possible provisions is determined by the agreement type."
custom_provisionsmap from strings to anyOptional

“A dictionary of user-defined provisions that extend the standard provisions set for this agreement type. • Keys = names of additional terms supplied by the customer (e.g., early_termination_fee). • Values = the term’s value, expressed as a primitive JSON type (string, number, boolean, etc.). This object reflects the data model as-defined by the customer, including property names and data types. note - Changes to the underlying data model will be reflected dynamically in this object at runtime.

additional_custom_clm_datamap from strings to anyOptional
Custom attributes originating from CLM in this agreement.
additional_custom_esign_datamap from strings to anyOptional
Custom attributes originating from eSign in this agreement.
languageslist of strings or nullOptional

List of languages applicable to the agreement, identified using BCP-47 language codes.

source_namestringOptional<=128 characters
The name of the source system which created this agreement, e.g. eSign, CLM, or Salesforce.
source_idstringOptional<=128 characters
The ID of the resource in the source system associated with this agreement. For example, it could be an ID of the envelope in eSign.
source_account_idstringOptional1-128 characters
The Account ID of the source system who creates this entity, e.g. eSign Account ID
linked_datalist of objectsOptional
metadataobjectOptional
_actionsobjectOptional
Available actions on the agreement. Actions are conditionally present based on the current state of the resource.
additional_user_defined_datamap from strings to anyOptionalDeprecated

User-defined/custom attributes included in this agreement.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error