> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/termsheet.md).

# Termsheet

Termsheet is a commercial real estate platform for managing deals, properties, companies, and related data.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Termsheet | API Key        |

### Termsheet

Connect to Termsheet to manage commercial real estate deals, properties, companies, and related data.

#### Set up in Termsheet

1. Sign in to your Termsheet account with an admin or account owner role.
2. Open your account/organization settings and find the API or developer section, then generate (or copy) an API key.
3. Copy the API key and keep it secret; it grants access to your Termsheet data.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Termsheet**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                       |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Your Termsheet API key from your account settings. [Provider instructions](https://app.termsheet.com/settings/api). |

**Provider documentation:** [Setup reference](https://www.termsheet.com/).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Termsheet** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### List Companies

Retrieve companies from Termsheet

#### Inputs

| Field             | Type    | Required | Description                                                        |
| ----------------- | ------- | -------- | ------------------------------------------------------------------ |
| Number of Records | integer | No       | Number of most recently updated records to return. Range: 1-10000. |
| Fetch All Records | boolean | No       | Fetch all records. May be slow for large datasets.                 |

#### Outputs

| Field            | Type        | Description                                           |
| ---------------- | ----------- | ----------------------------------------------------- |
| Total Available  | number      | The total number of companies available in Termsheet. |
| Records Returned | number      | The number of companies returned in this response.    |
| Companies        | dict\_array | The list of companies with selected fields.           |

### Get Company

Retrieve a company by ID from Termsheet

#### Inputs

| Field      | Type    | Required | Description                                       |
| ---------- | ------- | -------- | ------------------------------------------------- |
| Company ID | integer | Yes      | The unique identifier of the company to retrieve. |

#### Outputs

| Field        | Type   | Description       |
| ------------ | ------ | ----------------- |
| Company Data | object | The company data. |

### List Properties

Retrieve properties from Termsheet

#### Inputs

| Field                                     | Type                      | Required | Description                                                                                                            |
| ----------------------------------------- | ------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| Number of Records (Most Recently Updated) | integer                   | No       | Number of most recently updated records to return. Range: 1-10000.                                                     |
| Fetch All Records                         | boolean                   | No       | Fetch all records. May be slow for large datasets.                                                                     |
| Select Fields (Max 50)                    | multiple\_select (string) | No       | Specific fields to include in the response (select multiple). Options load from the selected connection. Default: \[]. |

#### Outputs

| Field            | Type        | Description                                         |
| ---------------- | ----------- | --------------------------------------------------- |
| Records Returned | number      | The number of properties returned in this response. |
| Properties       | dict\_array | The list of properties with selected fields.        |

### Get Property

Retrieve a property by ID from Termsheet

#### Inputs

| Field            | Type                      | Required | Description                                                                                                            |
| ---------------- | ------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| Property ID      | integer                   | Yes      | The unique identifier of the property to retrieve.                                                                     |
| Select Fields    | multiple\_select (string) | No       | Specific fields to include in the response (select multiple). Options load from the selected connection. Default: \[]. |
| Include Comments | boolean                   | No       | Whether to include comments for the property.                                                                          |

#### Outputs

| Field         | Type   | Description                             |
| ------------- | ------ | --------------------------------------- |
| Property Data | object | The property data with selected fields. |

### List Deals

Retrieve deals from Termsheet

#### Inputs

| Field                                     | Type                      | Required | Description                                                                                                            |
| ----------------------------------------- | ------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| Number of Records (Most Recently Updated) | integer                   | No       | Number of most recently updated records to return. Range: 1-10000.                                                     |
| Fetch All Records                         | boolean                   | No       | Fetch all records. May be slow for large datasets.                                                                     |
| Select Fields (Max 50)                    | multiple\_select (string) | No       | Specific fields to include in the response (select multiple). Options load from the selected connection. Default: \[]. |

#### Outputs

| Field            | Type        | Description                                       |
| ---------------- | ----------- | ------------------------------------------------- |
| Total Available  | number      | The total number of deals available in Termsheet. |
| Records Returned | number      | The number of deals returned in this response.    |
| Deals            | dict\_array | The list of deals with selected fields.           |

### Get Deal

Retrieve a deal by ID from Termsheet

#### Inputs

| Field                  | Type                      | Required | Description                                                                                                            |
| ---------------------- | ------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| Deal ID                | integer                   | Yes      | The unique identifier of the deal to retrieve.                                                                         |
| Select Fields (Max 50) | multiple\_select (string) | No       | Specific fields to include in the response (select multiple). Options load from the selected connection. Default: \[]. |
| Include Comments       | boolean                   | No       | Whether to include comments for the deal.                                                                              |

#### Outputs

| Field     | Type   | Description                         |
| --------- | ------ | ----------------------------------- |
| Deal Data | object | The deal data with selected fields. |

### Update Company

Update an existing company in Termsheet

#### Inputs

| Field            | Type    | Required | Description                                     |
| ---------------- | ------- | -------- | ----------------------------------------------- |
| Company ID       | integer | Yes      | The unique identifier of the company to update. |
| Fields to Update | object  | No       | Key-value pairs of company fields to update.    |

#### Outputs

| Field        | Type   | Description                                    |
| ------------ | ------ | ---------------------------------------------- |
| Company ID   | number | The unique identifier of the company.          |
| Company Name | string | The name of the company.                       |
| Company URL  | string | The web URL to view the company in Termsheet.  |
| Updated At   | string | When the company was last updated.             |
| Company Data | object | The complete company data returned by the API. |

### Update Deal

Update an existing deal in Termsheet

#### Inputs

| Field            | Type    | Required | Description                                  |
| ---------------- | ------- | -------- | -------------------------------------------- |
| Deal ID          | integer | Yes      | The unique identifier of the deal to update. |
| Fields to Update | object  | No       | Key-value pairs of deal fields to update.    |

#### Outputs

| Field      | Type   | Description                                 |
| ---------- | ------ | ------------------------------------------- |
| Deal ID    | number | The unique identifier of the deal.          |
| Deal Title | string | The title of the deal.                      |
| Deal URL   | string | The web URL to view the deal in Termsheet.  |
| Updated At | string | When the deal was last updated.             |
| Deal Data  | object | The complete deal data returned by the API. |

### Update Property

Update an existing property in Termsheet

#### Inputs

| Field            | Type    | Required | Description                                      |
| ---------------- | ------- | -------- | ------------------------------------------------ |
| Property ID      | integer | Yes      | The unique identifier of the property to update. |
| Fields to Update | object  | No       | Key-value pairs of property fields to update.    |

#### Outputs

| Field         | Type   | Description                                     |
| ------------- | ------ | ----------------------------------------------- |
| Property ID   | number | The unique identifier of the property.          |
| Property Name | string | The name of the property.                       |
| Property URL  | string | The web URL to view the property in Termsheet.  |
| Updated At    | string | When the property was last updated.             |
| Property Data | object | The complete property data returned by the API. |

### Get Lease

Retrieve a lease by ID from Termsheet

#### Inputs

| Field       | Type    | Required | Description                                                                           |
| ----------- | ------- | -------- | ------------------------------------------------------------------------------------- |
| Lease ID    | integer | Yes      | The unique identifier of the lease to retrieve.                                       |
| Property ID | integer | No       | The property ID (optional). If provided along with Unit ID, uses the nested endpoint. |
| Unit ID     | integer | No       | The unit ID (optional). If provided along with Property ID, uses the nested endpoint. |

#### Outputs

| Field      | Type   | Description                                  |
| ---------- | ------ | -------------------------------------------- |
| Lease ID   | number | The unique identifier of the lease.          |
| Lease URL  | string | The web URL to view the lease in Termsheet.  |
| Lease Data | object | The complete lease data returned by the API. |

### Create Lease

Create a new lease in Termsheet

#### Inputs

| Field       | Type    | Required | Description                                                  |
| ----------- | ------- | -------- | ------------------------------------------------------------ |
| Property ID | integer | Yes      | The property ID where the unit is located.                   |
| Unit ID     | integer | Yes      | The unit ID to create the lease for.                         |
| Lease Data  | string  | Yes      | The lease data to create. Can be a JSON string or an object. |

#### Outputs

| Field      | Type   | Description                                       |
| ---------- | ------ | ------------------------------------------------- |
| Lease ID   | number | The unique identifier of the newly created lease. |
| Lease URL  | string | The web URL to view the lease in Termsheet.       |
| Created At | string | When the lease was created.                       |
| Lease Data | object | The complete lease data returned by the API.      |

### Update Lease

Update an existing lease in Termsheet

#### Inputs

| Field            | Type    | Required | Description                                                                           |
| ---------------- | ------- | -------- | ------------------------------------------------------------------------------------- |
| Lease ID         | integer | Yes      | The unique identifier of the lease to update.                                         |
| Property ID      | integer | No       | The property ID (optional). If provided along with Unit ID, uses the nested endpoint. |
| Unit ID          | integer | No       | The unit ID (optional). If provided along with Property ID, uses the nested endpoint. |
| Fields to Update | string  | No       | Key-value pairs of lease fields to update. Can be a JSON string or an object.         |

#### Outputs

| Field      | Type   | Description                                  |
| ---------- | ------ | -------------------------------------------- |
| Lease ID   | number | The unique identifier of the lease.          |
| Lease URL  | string | The web URL to view the lease in Termsheet.  |
| Updated At | string | When the lease was last updated.             |
| Lease Data | object | The complete lease data returned by the API. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/termsheet.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
