---
title: Dealius API — Frequently Asked Questions
description: Everything you need to know about authenticating, accessing data, and integrating with the Dealius API.
---
[Skip to content](https://support.dealius.com/knowledgebase/dealius-api-frequently-asked-questions#main-content)
[Submit a Support Request](https://support.dealius.com/knowledgebase/kb-tickets/new?hsLang=en-us)
[](https://dealius.com/)
Open main navigation
Close main navigation
- [Submit a Support Request](https://support.dealius.com/knowledgebase/kb-tickets/new)
- [Contact us](https://support.dealius.com/knowledgebase/kb-tickets/new)
[Contact us](https://support.dealius.com/knowledgebase/kb-tickets/new?hsLang=en-us)
How can we help you?
- There are no suggestions because the search field is empty.
1. [Dealius Knowledge Base](https://support.dealius.com/knowledgebase?hsLang=en-us)
2. [User Guide](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us)
3. [Public API](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#public-api)
# Dealius API — Frequently Asked Questions
## Everything you need to know about authenticating, accessing data, and integrating with the Dealius API.
API documentation is available at any Dealius instance /swagger. For example, https://demo.dealius.com/api/swagger/index.html
---
**Do API tokens expire?**
Dealius offers two types of tokens:
**Temporary token** — Generated when a user logs in via API using their username and password. For security reasons, this token expires every 24 or 48 hours and must be renewed each session.
**Permanent token** — Generated in the Dealius web app under **User Settings \> API Keys**. This token is valid for 10 years and is passed in the request header as `X-Auth-Token`. It can be tested in Dealius Swagger using the **Authorize** button to create an authenticated session.
---
**How do I generate a permanent token?**
Go to **User Settings \> API Keys** in the Dealius web app to generate a permanent token. Once generated, you can test it in Dealius Swagger via the **Authorize** button. The token is sent in the header as `X-Auth-Token` and does not expire for 10 years.
Full instructions are available in your Dealius Swagger documentation at: `{your Dealius URL}/swagger`
---
**Does Dealius API have versioning?**
Not yet — versioning is planned for a future release. In the meantime:
- Updates that do not affect existing endpoints are announced on their release date.
- Breaking changes are announced at least one month in advance.
- When a new endpoint replaces an existing one, both are supported for two additional months to allow integrators time to update their code.
---
**Is the API the same on sandbox and production?**
Yes. The sandbox environment runs the same configuration and version as production, so you can test integrations with confidence before going live.
---
**What fields are required to create a deal via API?**
The required fields depend on the deal type, status, and system settings in your Dealius environment.
To create an active deal, the minimum required fields are:
- RepresentationTypeID
- DealTypeID
- DealName
- Client
- EstimatedCloseDate
- DealStatusID
- Probability
A deal can be created without a property, brokers, or financial details. However, submitting a deal for closure (Pending Close or Closed status) requires additional fields such as a linked property, opposite client, broker, payment(s), commissions, and rent or sale price. Some environments may require additional fields such as documents, deal source, or a submarket for the property.
Note: Deals cannot be closed via API.
The full list of supported fields is available in Swagger under the Deals endpoints. Switching to the **Model** tab within each endpoint shows notes for individual fields.
---
**How do I retrieve media files via the Dealius API?**
The Dealius API returns absolute media URLs as part of the JSON response. These URLs require authorization — HTML `![]()
` tags cannot include authorization headers directly due to browser restrictions. We recommend one of the following approaches:
**Option 1: Server-Side Proxy (Recommended)** Implement a secure proxy endpoint in your backend that forwards media requests to the Dealius API. This keeps authentication tokens out of client-side code, allows better caching, and is compatible with standard HTML image tags. It also allows the use of a long-lived API key instead of session tokens.
```
```
**Option 2: JavaScript Fetch + Blob URL** Use JavaScript to fetch the media file with an authorization header and convert it to a temporary blob URL. This is faster to implement and requires no additional backend endpoints.
`async function loadSecureImage(token, url, imgElement) {`
` const response = await fetch(url, {`
` headers: { 'X-Auth-Token': token }`
` });`
` const blob = await response.blob();`
` imgElement.src = URL.createObjectURL(blob);`
`}`
**What to avoid:** Do not include tokens in query strings or rely on unauthenticated fallback URLs — these pose security risks and break access control. Do not store media file URLs, as they may change.
---
**Is there a guide for pulling listings data to a public website?**
Yes. Please contact your Dealius representative to request the **Dealius API Integration** overview guide.
---
**Is there a guide for pushing deals to Dealius?**
Yes. Please contact your Dealius representative to request the **Pushing Deals via Dealius API** guide.
- [User Guide](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#main-content)
- [People](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#people)
- [Comps](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#comps)
- [Tracker](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#tracker)
- [Closing & Deleting a Deal](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#closing-deleting-a-deal)
- [List of Deals](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#list-of-deals)
- [System Settings](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#system-settings)
- [Outlook Plug-in](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#outlook-plug-in)
- [Cashflow](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#cashflow)
- [Manage Data](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#manage-data)
- [Notifications](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#notifications)
- [Brokers](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#brokers)
- [Tasks](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#tasks)
- [Authorization / Login](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#authorization-login)
- [Adding a Deal](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#adding-a-deal)
- [Properties](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#properties)
- [Leaderboards](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#leaderboards)
- [QuickBooks Integration](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#quickbooks-integration)
- [Glossary & Formulas](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#glossary-formulas)
- [Accounting](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#accounting)
- [Listings](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#listings)
- [Accounting Reports](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#accounting-reports)
- [Deal Profile & Entries](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#deal-profile-entries)
- [My Settings](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#my-settings)
- [CRM Pro](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#crm-pro)
- [Dealia - AI](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#dealia-ai)
- [Outlook Sync](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#outlook-sync)
- [Public API](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#public-api)
- [SharpLaunch Integration](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#sharplaunch-integration)
- [Roles & Permissions](https://support.dealius.com/knowledgebase/user-guide?hsLang=en-us#roles-permissions)
- [Reports](https://support.dealius.com/knowledgebase/reports?hsLang=en-us#main-content)
- [Reporting Videos & Tutorials](https://support.dealius.com/knowledgebase/reports?hsLang=en-us#reporting-videos-tutorials)
- [Login & Settings](https://support.dealius.com/knowledgebase/login-settings?hsLang=en-us#main-content)
- [Login & User Profile Settings](https://support.dealius.com/knowledgebase/login-settings?hsLang=en-us#login-user-profile-settings)
- [Tracker](https://support.dealius.com/knowledgebase/tracker?hsLang=en-us#main-content)
- [Broker Tracker Video & Tutorials](https://support.dealius.com/knowledgebase/tracker?hsLang=en-us#broker-tracker-video-tutorials)
- [Accounting](https://support.dealius.com/knowledgebase/accounting?hsLang=en-us#main-content)
- [Accounting Videos & Tutorials](https://support.dealius.com/knowledgebase/accounting?hsLang=en-us#accounting-videos-tutorials)
- [Deals](https://support.dealius.com/knowledgebase/deals?hsLang=en-us#main-content)
- [Deals Videos & Tutorials](https://support.dealius.com/knowledgebase/deals?hsLang=en-us#deals-videos-tutorials)
- [People](https://support.dealius.com/knowledgebase/people?hsLang=en-us#main-content)
- [People Videos & Tutorials](https://support.dealius.com/knowledgebase/people?hsLang=en-us#people-videos-tutorials)
- [Tasks](https://support.dealius.com/knowledgebase/tasks?hsLang=en-us#main-content)
- [Task Videos & Tutorials](https://support.dealius.com/knowledgebase/tasks?hsLang=en-us#task-videos-tutorials)
- [Dashboard](https://support.dealius.com/knowledgebase/dashboard?hsLang=en-us#main-content)
- [Dashboard Videos & Tutorials](https://support.dealius.com/knowledgebase/dashboard?hsLang=en-us#dashboard-videos-tutorials)
- [Properties & Listings](https://support.dealius.com/knowledgebase/properties-listings?hsLang=en-us#main-content)
- [Properties & Listings Videos & Tutorials](https://support.dealius.com/knowledgebase/properties-listings?hsLang=en-us#properties-listings-videos-tutorials)
[](https://dealius.com/)
201 Specialty Point, Sanford, FL 32771
Copyright © 2025,