canonical: https://jentic.com/apis/dealpath.com/dealpath

# Dealpath API

Dealpath is a real estate deal management platform whose Developer API exposes 36 endpoints across assets, deals, properties, funds, investments, loans, leases, and supporting reference data. The API supports the full lifecycle of a real estate transaction: creating deals, attaching them to funds, registering properties, and listing the configurable fields and option lists that back custom data on each entity. Authentication is bearer-token, and many endpoints follow a hierarchical pattern such as /attachment/fund/{fund_id}/deal/{deal_id} that mirrors how investment teams structure their portfolios.

## For AI agents

Create and update real estate assets, deals, funds, properties, and leases in Dealpath, attach deals to funds, and read the configurable field schema behind each entity.

## Scope

Does not handle property accounting close, tenant payment processing, or document e-signature - use for Dealpath deal, asset, fund, and lease record management only.

## Capabilities

- Create, list, update, and delete assets through the /asset and /assets endpoints
- Manage real estate deals end-to-end with /deal, /deals, and /deal/{deal_id}
- Register and update funds, then attach deals to funds via /attachment/fund/{fund_id}/deal/{deal_id}
- Read configurable fields and list options that back Dealpath's custom-data model
- Manage investments, loans, and leases as first-class entities under their dedicated tags
- Maintain property records linked to assets and deals across the portfolio

## Use cases

### Deal pipeline ingestion from external sources

Investment teams often source deals from broker emails, CRMs, or third-party listing services and need them mirrored into Dealpath. POST /deal creates the deal, /deals lists existing ones for deduplication, and /attachment/fund/{fund_id}/deal/{deal_id} associates the new deal with the right fund. This pattern keeps Dealpath as the system of record while letting top-of-funnel signals come from anywhere.

Example prompt: POST /deal with the new deal payload, then POST /attachment/fund/{fund_id}/deal/{deal_id} to link it to the target fund.

### Portfolio-wide reporting on assets and properties

Asset managers building reports or dashboards need to enumerate the portfolio. GET /assets and GET /properties return the populated entities, GET /deals scopes by deal status, and GET /funds gives the fund-level rollup. Pulling all four into a warehouse on a schedule produces the foundation for cross-portfolio analytics without bespoke spreadsheets.

Example prompt: GET /assets with pagination, then GET /deals filtered by fund_id and reconcile each asset's deals into a single report row.

### Custom field schema introspection

Dealpath configurations rely heavily on custom fields and list options that vary per tenant. The Fields and List Options endpoints let an integration discover the active schema before writing data, ensuring that POSTs to /deal or /asset reference real field ids and valid option values. This is critical for keeping integrations resilient when an admin adds a new dropdown.

Example prompt: List Fields for the Deal entity, identify the field id for 'Deal Stage', and only then POST /deal with that field populated to a known list option.

### AI agent orchestrating deal creation through Jentic

An agent reading deal terms from an inbound email can search Jentic for 'create a Dealpath deal', extract the structured fields, and execute the POST without ever holding the bearer token. The agent can then chain /attachment/fund to link the deal to the right fund and confirm the result by GETting /deal/{deal_id} - a complete pipeline ingestion in three calls.

Example prompt: Search Jentic for 'create a Dealpath deal', execute /deal with the parsed terms, then /attachment/fund/{fund_id}/deal/{deal_id} and finally GET /deal/{deal_id} to verify.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /deal | Create a real estate deal |
| GET | /deals | List deals across the portfolio |
| GET | /deal/{deal_id} | Retrieve a specific deal |
| POST | /asset | Create an asset |
| GET | /assets | List assets |
| POST | /fund | Create a fund |
| POST | /attachment/fund/{fund_id}/deal/{deal_id} | Attach a deal to a fund |

## Key resources

- **Assets** — Real estate asset CRUD operations
- **Deals** — Deal lifecycle from creation to deletion
- **Funds** — Fund records and deal attachments
- **Properties** — Property records linked to assets and deals
- **Investments** — Investment entities tied to deals
- **Loans** — Loan records on deals or assets
- **Leases** — Lease records under properties
- **Fields** — Custom field schema for Dealpath entities
- **List Options** — Allowed option values for list fields
- **Attachments** — Cross-entity attachment endpoints (e.g., deal-to-fund)

## Why Jentic

- **Setup:** Wiring the Dealpath API by hand means learning its bearer auth and mapping its hierarchical deal, asset, fund, and attachment paths yourself. Through Jentic you install once, import the Dealpath API from the API Directory, store the bearer token once, and your agent calls it.
- **Permission scoping:** Dealpath puts the deal id and fund id in the URL path (/deal/{deal_id}, /attachment/fund/{fund_id}/deal/{deal_id}), so a rule can pin your agent to one deal or fund. You choose the operations it may call, so creating deals, assets, or funds is included only if you add it.
- **Credential handling:** Your Dealpath bearer token is stored once, encrypted, by your own Jentic One instance and applied as the Authorization: Bearer header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a Dealpath deal' or 'attach a deal to a fund', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without navigating Dealpath's hierarchical attachment paths by hand.

## Related APIs

- **AppFolio API** — Property management platform that handles operations downstream of an acquisition.
- **Salesforce API** — General-purpose CRM that some smaller real estate teams use for pipeline tracking.
- **HubSpot CRM Deals** — Generic deal pipeline tracking without the real-estate-specific schema.

## FAQ

### What authentication does the Dealpath API use?

Dealpath uses bearer-token authentication on every endpoint. Through Jentic the token is held in the encrypted vault and applied to the Authorization header at execution time, so the raw token never enters the agent's context.

### Can I attach a deal to a fund through the Dealpath API?

Yes. POST /attachment/fund/{fund_id}/deal/{deal_id} creates the link between an existing deal and an existing fund. Both ids must already exist - call POST /deal and POST /fund first if either side is new.

### How do I discover the custom fields configured on Dealpath?

Use the Fields and List Options endpoints to read the active schema before posting data. This lets your integration reference real field ids and valid option values rather than hard-coding labels that an admin may have changed.

### What are the rate limits for the Dealpath API?

The OpenAPI spec does not document explicit rate limits. For portfolio-wide reads, paginate /assets and /deals rather than calling individual GETs, which keeps total request count manageable on large tenants.

### How do I create a Dealpath deal through Jentic?

Run pip install jentic, search for 'create a Dealpath deal', and Jentic returns the /deal operation with its input schema. Load it, supply the deal payload, and execute. Chain /attachment/fund/{fund_id}/deal/{deal_id} afterwards to associate it with the correct fund.

### Does the Dealpath API expose document or task management endpoints?

Not in this 1.3 spec. The 36 endpoints cover assets, deals, properties, funds, investments, loans, leases, fields, list options, and cross-entity attachments. Document upload and task workflows are not part of this surface.

### Can I limit what my agent is allowed to do with the Dealpath API?

Yes. Because you self-host Jentic One, your own rules decide which Dealpath operations and credentials the agent may use. Since Dealpath puts the deal id and fund id in the URL path, such as /deal/{deal_id} and /attachment/fund/{fund_id}/deal/{deal_id}, a rule can pin the agent to a single deal or fund. You also choose which operations are permitted, so creating deals, assets, or funds is available only if you explicitly allow it.