Overview
Connect your systems with LinkSquares Finalize by using the LinkSquares Finalize API to allow legal teams to collaborate with their stakeholders (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 agreements from other systems while ensuring legal teams will be able to receive and work on these requests from Finalize.
- View agreement status and version updates from other systems as legal teams work on agreements within Finalize.
Whats New
11/25/2025: Finalize API Update: Retrieve Comments from Finalize Activity Log
Endpoint: GET https://api.linksquares.com/api/finalize/v2/agreements/<agreement_id>/activity_logs
Functionality: In addition to the ability to create a comment via the API, you can now retrieve detailed activity log entries, including user comments.
Filtering: The endpoint supports an optional date/time filter, allowing you to fetch only comments and activity that occurred after a specified timestamp.
- ?created_after=yyyy-mm-dd
Example 1: Retrieve Comments in the Activity Log
GET https://api.linksquares.com/api/finalize/v2/agreements/<agreement_id>/activity_logs
200 OK
{
"data": [
{
"created_at": "2025-11-25T17:12:01Z",
"kind": "ActivityEntry",
"text": "created agreement with no tasks in Ready for Signature",
"author": {
"id": "5d3e8fd4-89cf-11f0-aeb4-2bf90626f0e2",
"fullname": “Jane Curtin,
"email": “jcurtin+30bd7468-1e1d-4bbf-a327-54130eae7bdb@acme.com"
}
},
{
"created_at": "2025-11-04T18:16:51Z",
"kind": "ActivityEntry",
"text": "sent an email to euddin@acme.com",
"author": {
"id": "5d3e8fd4-89cf-11f0-aeb4-2bf90626f0e2",
fullname": “Jane Curtin,
"email": “jcurtin+30bd7468-1e1d-4bbf-a327-54130eae7bdb@acme.com"
}
}, {
"created_at": "2025-11-18T18:57:27Z",
"kind": "ActivityEntry",
"text": "added Ben Matlock as a Collaborator",
"author": {
"id": "5f08e5d0-89cf-11f0-aee5-078a42d16c76",
fullname": “Jane Curtin,
"email": “jcurtin+30bd7468-1e1d-4bbf-a327-54130eae7bdb@acme.com"
}
}
Example 2: Retrieve Comments in the Activity Log after a specific date
200 OK
{
"data": [
{
"created_at": "2025-11-18T19:42:47Z",
"kind": "Comment",
"text": "Can you double check the customer has an NDA?!",
"author": {
"id": "ca2fb9d8-8cc7-11f0-8781-438519318432",
fullname": “Jane Curtin,
"email": “jcurtin+30bd7468-1e1d-4bbf-a327-54130eae7bdb@acme.com"
}
},
{
"created_at": "2025-11-18T19:43:19Z",
"kind": "ActivityEntry",
"text": "Verified the signatures required.",
"author": {
"id": "ca2fb9d8-8cc7-11f0-8781-438519318432",
fullname": “Jane Curtin,
"email": “jcurtin+30bd7468-1e1d-4bbf-a327-54130eae7bdb@acme.com"
}
}
]
Finalize API Functionality Highlights
- Create agreements and requests by sending documents and data from third-party systems.
- Upload attachments to existing agreements.
- Download agreement versions and attachments.
- View the current status of any agreement.
- Retrieve information about and approve tasks.
To learn more about the available Finalize API endpoints, reference our article on the LinkSquares API Overview.
Setup and Access
To learn more about setting up and installing the API key, reference our article on Managing API Keys.
LinkSquares Finalize Data Model
The following sections outline several core data models and concepts. These core data models and concepts, along with a basic understanding of Finalize, will help users understand how to interact with the Finalize API. To learn more about Finalize, reference our articles on LinkSquares Finalize.
Templates
Users can have templates to represent different types of agreements (such as a Non-Disclosure Agreement or a Master Services Agreement). Templates define the information that needs to be populated to create a particular type of agreement. Templates are defined by the legal team.
There are three kinds of templates supported by the Finalize API:
- Draft (Our Paper)
- Intake (3rd Party Paper)
- Request Forms (Our Paper)
For all agreements, the user must answer a set of agreement detail fields, which are metadata questions about the agreement. This data does not enter the agreement itself but helps to categorize and contextualize the agreement.
- In Draft (Our Paper) agreements, Finalize will merge data provided by the user to populate predefined variables (tokens) in the template to generate the agreement.
- Intake (3rd Party Paper) workflows require the user to upload a third-party agreement for review by legal.
- Request Forms (Our Paper) consist of agreement detail fields only.
| Template Type | Agreement Detail Fields | Additional Information |
| Draft (Our Paper) | Required | Tokens |
| Intake (3rd Party Paper) | Required | File Upload |
| Request Forms (Our Paper) | Required | N/A |
Agreements
Agreements represent a contract being worked on by legal. Agreements are created from a template. Users can track the states, versions, and attachments of agreements, as well as view the associated agreement detail fields and responses.
Any business manager can draft an agreement by filling out the necessary agreement detail fields and, if needed, uploading an intake agreement or providing values to populate tokens of a Draft (Our Paper) agreement.
Agreement Detail Fields
Agreement detail fields capture agreement metadata. Agreement metadata is structured data that contextualizes the agreement but does not reside in the agreement itself. This data may need to remain separate from the agreement for ease of access and categorization.
The types of agreement detail fields are:
- Text
- Paragraph
- Date
- Numbers
- Multiple-selection
- Single-selection
- URL
Note:
- Date fields must be in the ISO8601 format.
Tokens
Tokens are “mail merge” fields that are configured in the template for an agreement. When creating a new agreement from a template, users can input data for all available tokens.
For example, an NDA template may require #[EFFECTIVE_DATE]# and #[COUNTERPARTY_NAME]# to be filled in. To create the agreement, the user must submit valid values for each of these tokens.
Each token has a designated data type that the value must match. The available data types are:
- Text field
- Text area
- Date
- Clause
- Multiple-selection
- Single-selection
Note: Date tokens must be in the ISO8601 format.
At this time, all standard token types are supported by the Finalize API. Pricing table tokens are not currently supported by the Finalize API.
Agreement Versions
Agreement versions are the actual files that represent each version of an agreement. Versions can be stored in either DOCX or PDF format. The Finalize API provides the ability to upload a new agreement version and download an agreement version file in its original format.
Attachments
Attachments, also known as support files, can be uploaded to an agreement.
The supported file types are as follows.
| DOC* | DOCX | XLS | XLSX | PPT | PPTX | |
| MP3 | GIF | JPEG | JPG | PNG | BMP | SVG |
| TXT | MP4 | MPEG | MPG | MOV | WMV | AVI |
Note: Within API code, file extensions should be referenced using all lowercase letters.
The Finalize API provides the ability to upload or download attachments for an existing agreement.
Agreement Statuses
Agreement statuses represent what stage of the contract lifecycle a given agreement is in. The following table outlines the agreement statuses available within the Finalize API. A description of each status, their identifier within the Finalize API, and what other statuses each status can transition to is also provided.
| Agreement Status | Description | Finalize API Identifier | Statuses To Transition To |
| Request Pending | An agreement request starts in this status if the Request Form has been filled out but an initial draft of the agreement has not been started. | request_pending |
|
| Internal Review | An agreement is being reviewed internally or needs to be reviewed internally before being sent to the counterparty. | internal_review |
|
| Counterparty Review | An agreement has been sent to the counterparty for review or the agreement needs to be sent to the counterparty for review. | counterparty_review |
|
| Ready for Signature | An agreement will automatically move into this status once all parties approve the agreement and no other tasks or approvals are outstanding. | ready_for_signature |
|
| Out for Signature | An agreement has been sent to the required counterparties for signature. | out_for_signature |
|
| Partially Signed | An agreement has been signed by some but not all of the required parties. | partially_signed |
|
| Fully Signed | An agreement has been signed by all required parties. Agreements will automatically move to this status when all required signatures have been collected. | fully_signed | N/A |
| Done | The agreement is complete but does not require signature. | done | N/A |
| Paused |
The work on the agreement has been paused until further notice. If work resumes on this agreement, it will return to the status it was in before being paused. |
paused_request_pending paused_internal_review paused_counterparty_review paused_ready_for_signature paused_out_for_signature paused_partially _signed |
A paused agreement can only be transitioned to the status the agreement was in prior to being paused A paused agreement can only transition to a status with the corresponding identifier. For example, paused_request_pending can only transition to request_pending. |
Note:
- When an agreement is moved to the Paused status, the user will need to define which state to return the agreement to should it become unpaused. For example, if an agreement should be returned to the Internal Review status if it becomes unpaused, the user should set that agreement's Finalize API Identifier to 'paused_internalreview'.
- If the tasks associated with an agreement have been approved and completed and no outstanding tasks remain, the agreement can transition to a signature status (Ready for Signature, Out for Signature, Partially Signed).
- Requests can only be transitioned by creating an agreement from the Request in the Finalize web app. The status of the agreement will be based on the initial status of the template used. If there are no outstanding tasks at the time the agreement is created, it will begin in the Ready for Signature status.