What is the LinkSquares API?
The LinkSquares API provides a simple, seamless way to integrate the LinkSquares applications with your existing systems and workflows, allowing you to access your contract data natively in any system.
LinkSquares API Platform
LinkSquares APIs utilize a common API key-based authentication, which is invoked by embedding the API key in the request header. API endpoints are REST/HTTP unless otherwise specified, with request and response data in JSON format.
LinkSquares offers self-service API key management, which is accessible to Administrator users.
LinkSquares Analyze API
Connect your systems with LinkSquares Analyze as a source of agreement documents or to retrieve metadata and Smart Values for your existing, processed agreements. The LinkSquares Analyze API is split into several endpoints:
Retrieve Metadata
The Analyze Retrieve Metadata API allows you to extract all metadata (Smart Values, Terms, Types, Tags, Parent Child Hierarchy) from your Analyze agreements in bulk or individually in a JSON format.
Filter on Types or Tags to retrieve data for specific sets of agreements or specify a date filter to retrieve only agreements that were updated within a certain timeframe. This date filter is conducive to integrations that maintain syncs between LinkSquares and other systems, as it will only pick up data that has been updated since the last sync interval.
The agreements visible in the response will match the agreements the API user has permission to view. You can use this endpoint to find agreements you are interested in or get a high-level view of many agreements at once. With the agreement identifier, select data for one agreement at a time if that specificity is needed.
Retrieve Parent Child Hierarchy
The Retrieve Parent Child Hierarchy API provides a view of all related agreements within a given hierarchy to provide you with more insight into the relationship of these agreements.
This information is returned in the form of an unsorted JSON hash of the entire tree structure. This tree structure will include the IDs and names of all relevant agreements as well as outline their hierarchical relationship to one another.
Import Agreement
Import your DOCX or PDF files from external systems directly into LinkSquares Analyze, along with any pre-specified metadata values (Terms, Types, Tags, Parent Child Hierarchy). This enables you to send documents to LinkSquares Analyze for processing, while also capturing key data points from your source system for additional context.
- Source-System Agnostic
- The Create Agreement API allows the transfer of agreements to LinkSquares Analyze from a wide range of sources. If you can extract the file and relevant data from your system of choice, you can send it to LinkSquares Analyze using the Create Agreement API.
- Capturing Additional Metadata
- For example, an agreement may have a value of “Originating Salesperson” that exists in the source system. With the Create Agreement API, this metadata can be transmitted along with the file to be stored as a User Generated Value in LinkSquares Analyze.
Furthermore, storing an external identifier as a custom Term on the agreement provides an easy way to cross-reference the agreement in LinkSquares Analyze and other systems in the future. For example, if your source system is NetSuite when sending over the agreement file, you may choose to send a value for a Term “NetSuite ID” of “NS-1234.” In the future, when retrieving metadata for that agreement, you’ll be able to use that value (“NS-1234”) to know what records the agreement corresponds to in NetSuite.
Create Agreement Attachment
The Add Agreement Attachment API allows you to add an attachment to an existing agreement. This endpoint requires the user to provide a file name and responds with an upload URL that will be used to upload the attachment.
Acceptable file types for an agreement attachment include CSV, DOC, DOCX, PDF, TXT, XLS, and XLXS.
Retrieve Agreement Terms
The Retrieve Agreement Terms API allows users to retrieve a list of all the terms in their LinkSquares environment and their associated IDs. With this information, users can then properly structure their term request to update the terms associated with a given agreement.
Download Agreement File
The Download Agreement File API allows users to download the file for the main agreement so it can be sent to another system where it may need to be accessed for compliance, reporting, or auditing processes.
Update Agreement
The Update Agreement API consists of endpoints that can be used to update different aspects of an Analyze agreement. Currently, endpoints are available that allow users to update the following agreement metadata:
- Agreement name
- Agreement type
- Agreement terms
- Agreement note
- Agreement tags
- Create, add, and delete tags to Agreements in Analyze.
- Parent Child Hierarchy
LinkSquares Finalize API
Connect your systems with LinkSquares Finalize to allow legal teams to collaborate with their stakeholders (e.g., procurement, business managers, sales) without requiring those stakeholders to leave their preferred applications.
The Finalize API enables customers to build integrations to:
- Draft or request contracts from other systems, while ensuring legal teams will be able to receive and work on these requests from LinkSquares Finalize
- View contract updates such as status and agreement versions from other systems as legal teams work on contracts within LinkSquares Finalize
Retrieve Templates
The Retrieve Templates API gives you the ability to view a list of available Finalize templates and present template form fields directly to your users, so they can be filled out in third-party systems for automated agreement and request creation.
You can filter the list of templates based on whether they are Draft (our paper), Intake (third-party paper), or Request Forms. For each template, you can see the Agreement Detail Questions and tokens (for Draft), which need to be populated by your users in third-party systems in order to create an agreement.
Retrieve and Approve Tasks
The Retrieve and Approve Tasks API consists of three endpoints that allow you to get information about and action upon tasks associated with your LinkSquares environment. Users can retrieve a list of all tasks or use the task ID to get information about a specific task. Users can also update the status of a single task to approved.
Create Agreement
Once you’ve retrieved the data necessary to fill out a template, you are ready to create an agreement in Finalize. Draft, Intake, and Request forms are all supported.
- Submit documents for legal review
- Using the Create Agreement API with an Intake template users can submit documents from a third-party system into Finalize for legal review.
- Draft or request agreements
- Users can submit forms to request agreements or draft template agreements from a third-party system by using the Create Agreement API
- Capturing metadata in agreement detail fields
- In some cases, capturing data from the source system that is not part of the agreement itself may be useful, such as “Contract Value”, which also happens to reside in the source system. You can map that data to an Agreement Detail question so that it is stored in Finalize. From Finalize, it can be mapped for later ingestion as an Analyze Term.
Update Agreement
With the Update Agreement API, you can upload files as attachments to existing agreements, upload documents as new agreement versions, and transition the agreement state, all from a third-party system.
- Upload attachments
- Users can submit files from a third-party system to be stored on the relevant Finalize agreement, providing additional context for legal teams as they work on the agreement.
- Update agreement status
- Allow users to change agreement status from a third-party system.
- Upload new agreement versions
- Allow users to submit files as a new version, transitioning the agreement to a new status in the process.
- Update Activity
- Allow users to make comments on the Finalize agreement
Retrieve Agreements
The Retrieve Agreements API allows you to view a list of agreements, which can be sorted by name, or by most recent status update. The list can also be filtered by keyword or status.
With the identifier for a specific agreement, you can also download any agreement version or attachment.
- Syncing status updates
- Sorting by most recent status update allows you to maintain a daily sync that looks for any agreements that have been updated within the past day and then reflects that update in a third-party system.
- Downloading agreement versions or attachments
- For simple agreement types, such as Non-Disclosure Agreements, the user drafting the agreement from the third-party system also wants to download the document as soon as Finalize generates the agreement version.