> ## Documentation Index
> Fetch the complete documentation index at: https://docs.asteragents.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DealCloud

> Connect DealCloud to your agents

## Connect DealCloud

An organization admin connects DealCloud in **Control Hub > Integrations > DealCloud**. The connection is shared across the organization. Once an admin enables DealCloud, members can connect it too.

1. Get a client ID and API key for a DealCloud user from your DealCloud administrator or Intapp support. Agents act with that user's permissions, so consider a dedicated integration user with access to only the lists agents should see.
2. In Aster, enter your DealCloud site (the address you sign in at, such as `https://yourfirm.dealcloud.com`), the client ID, and the API key.
3. Save. Aster signs in and reads your list of entry types before saving, so a wrong key or site is caught right away.
4. Enable the DealCloud tools on your agent.

## Available tools

| Tool | Use |
| - | - |
| `dealcloud_get_schema` | List your entry types (Company, Contact, Opportunity, Fund, and your firm's custom lists), an entry type's fields and choice options, or your DealCloud users. |
| `dealcloud_query` | Read records from an entry type, with an optional filter. Read-only. |
| `dealcloud_manage_records` | Create or update up to 100 records at a time. |

Every firm's DealCloud is configured differently, so agents look up your entry types and fields with `dealcloud_get_schema` before reading or writing.

## Filters

`dealcloud_query` takes DealCloud's filter syntax:

* Text: `{CompanyName: {$contains: "Capital"}}`
* Dates, with a full timestamp: `{LogDate: {$gt: "2026-06-01T00:00:00Z"}}`
* Choice fields, by option name: `{Stage: {$in: ["Screening", "Diligence"]}}`
* Reference and user fields, by id: `{Company: 5678901}`
* Combined: `{$and: [{...}, {...}]}`

Results report the total number of matches. Agents page through them 1 to 1,000 records at a time. Large results are attached to the conversation.

## Writing records

Choice, reference, and user fields are written as ids, which agents get from `dealcloud_get_schema` or a query. DealCloud checks required and unique fields, and can save some records in a batch while rejecting others. Each record's result says whether it was created, updated, or rejected and why. Calculated and system fields can't be written. The tools don't delete records.

## Example prompts

* "Which opportunities did we log this month, and what stage is each in?"
* "Find every company in DealCloud with 'Capital' in the name and its website."
* "Add Acme Partners as a company and log this teaser as a new opportunity sourced from them."
* "Move these three deals to Passed and note why."

## Troubleshooting

* **Rejected client ID or API key:** Confirm both with your DealCloud administrator, or get a new key, and reconnect.
* **Access denied:** The API key's user can't see that list or make that change. Adjust the user's permissions in DealCloud.
* **A filter returns nothing:** Use a full timestamp for dates, `$in` for choice fields, and write `&` as `&` in text.

The API key stays server-side and is hidden in connection responses. To rotate it, edit the connection; to remove it, disconnect DealCloud in Integrations.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.