Docs
Welcome to the DealCloud API Docs! This site provides a comprehensive overview of our REST APIs, their capabilities, and available endpoints. Whether you're building custom integrations, automating workflows, or exploring advanced use cases, you'll find detailed guidance, examples, and best practices throughout. To dive into sample implementations, visit the Guides section.
How to Run Examples
Most examples use HTTP requests, making them accessible regardless of your programming language. You do not need to be an expert in HTTP to follow along, but you may pick up some basics through the examples. To try out the examples, you can use tools like Swagger, Postman, VSCode, or any other tool that supports HTTP requests.
Swagger
Each DealCloud site provides an interactive Swagger page for testing API calls. Replace {{host}} with your site’s domain (e.g. example.dealcloud.com).
https://{{host}}/swaggerPostman
Postman can consume the Swagger/OpenAPI spec file exposed at
https://{host}/swagger/currentVSCode Configuration
VSCode requires the REST Client plugin (opens in a new tab)
Overview of Functional APIs
Our APIs are organized into functional areas. Each area includes multiple endpoints designed to help you perform specific tasks related to that category.
Authentication – Provides tokens for use with all other APIs.
User Management – Endpoints for managing users.
Schema – Endpoints to help you understand your site's structure.
Data – Endpoints for manipulating site data.
Backups – Endpoints for generating backup exports.
Publications – Endpoints for working with real-time event APIs.
Relationship Intelligence – Import data points for Relationship Intelligence.