Docs

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

A majority of the docs for the API are written in HTTP, allowing for language agnostic examples. You're not expected to learn HTTP but may learn it anyway through the examples. To run the examples, you can use Swagger, POSTMAN, VSCode or your preferred mechanism for making HTTP requests.

Swagger

Every site has a Swagger endpoint exposed at

https://{url}/swagger

Postman

Postman can consume the Swagger/OpenAPI spec file exposed at

https://{url}/swagger/current

VSCode Configuration

VSCode requires the REST Client plugin (opens in a new tab)

Quick overview of our APIs

Our APIs are grouped into functional areas. Each area contains several API endpoint designed to help you accomplish tasks related to these areas.

  1. Authentication - this area provides tokens that can be used with all other APIs
  2. User Management - this area provides endpoints for managing users
  3. Schema - this area contains endpoints to help you understand your site's structure.
  4. Data - this area contains endpoints for minipulating data in the site.
  5. Backups - this area contains endpoints for generating backup exports from your site
  6. Publications - this area contains endpoints for working with our real-time event APIs
  7. Marketing - this area allows you to work with marketing data, useful if you're subscribed to our Dispatch product
  8. Relationship Intelligence - this area allows you to work with our Relationship Intelligence APIs.
Token