canonical: https://jentic.com/apis/swaggerhub.palace/agreement-integration

# Palace Agreement Integration

<p>The 'Agreement' integration focuses on allowing 3rd party systems to sync contacts / properties from Palace and create new 'Owners', 'Properties', 'Tenancies' and 'Sub-Tenants'. It also allows for sending official 'Agreements' back to Palace as a file document (PDF Recommended).<br><br>The 'Agreement Integration' area does NOT require an upgrade from a 'Standard' API account to a 'Premium' API . The API exposes 14 endpoints.

## For AI agents

Programmatically all 'agents' with detailed data, all 'owners' with detailed data. Covers 14 operations.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- All 'Agents' with detailed data
- Manage crm data programmatically
- Integrate Agreement Integration into automated workflows
- Query and filter Agreement Integration records by parameters
- Monitor Agreement Integration operational status and events

## Use cases

### CRM Operations

Use the Agreement Integration to perform crm operations programmatically. The API provides 14 endpoints covering core functionality including all 'agents' with detailed data, all 'owners' with detailed data, all 'properties' with detailed data.

Example prompt: Call GET /v2ViewAllDetailedAgent/JSON to all 'agents' with detailed data

### Automated developers Management

Automate developers operations by combining multiple Agreement Integration endpoints. Agents can all 'owners' with detailed data and then all 'properties' with detailed data in a single workflow.

Example prompt: Call GET /v2ViewAllDetailedOwner/JSON to all 'owners' with detailed data, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Agreement Integration endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'all 'agents' with detailed data', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /v2ViewAllDetailedAgent/JSON | All 'Agents' with detailed data |
| GET | /v2ViewAllDetailedOwner/JSON | All 'Owners' with detailed data |
| GET | /v2ViewAllDetailedProperty/JSON | All 'Properties' with detailed data |
| GET | /v2ViewAllDetailedTenancy/JSON | All 'Tenancies' with detailed data |
| GET | /v2ViewAllDetailedSupplier/JSON | All 'Suppliers' with detailed data |
| GET | /v2ViewAllExpense/JSON | All 'Expenses' with Description |
| GET | /v2ViewAllDetailedDiaryGroup/JSON | All 'Diary Groups' with Description |
| GET | /v2AvailableProperties/JSON | All current available properties with detailed data |

## Key resources

- **developers** — Operations available to developers

## Why Jentic

- **Setup:** Wiring Agreement Integration by hand means targeting the getpalace.com RestService host, matching the view and insert JSON paths for agents, owners, properties, and tenancies, and parsing each response yourself. Through Jentic you install once, import Agreement Integration from the API Directory, and since it takes no credential your agent calls it straight away.
- **Permission scoping:** Agreement Integration exposes account-wide view and insert operations whose targets travel in the request body, not the URL path, so scope the agent to the operations it needs, such as viewing detailed properties or owners. Write operations like inserting an owner or a tenancy are excluded unless you add them to the allowed set.
- **Credential handling:** Agreement Integration needs no credential to call, so there is nothing to store. If you add related services later, any credential is stored once, encrypted, by your own Jentic One instance and injected at execution time, never entering the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'view all detailed properties' or 'insert a new owner', and Jentic returns the matching Agreement Integration operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Agreement Integration use?

The Agreement Integration uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I all 'agents' with detailed data with the Agreement Integration?

Yes. Use the GET /v2ViewAllDetailedAgent/JSON endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Agreement Integration?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I all 'agents' with detailed data through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'all 'agents' with detailed data'. Jentic returns the matching Agreement Integration operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Agreement Integration have?

The Agreement Integration exposes 14 endpoints covering developers operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Agreement Integration operations the agent may call, so you can allow only the read endpoints it needs, such as viewing detailed agents, owners, properties, or tenancies. The write operations that create owners, properties, and tenancies stay out of reach unless you explicitly add them to the allowed set. Since these calls carry their targets in the request body rather than the URL path, scoping is done at the operation level, giving you control over exactly what the agent can view or insert.