Schema APIs

DealCloud is a flexible system of record used by many industries. Because each industry may use different object models and terminology, DealCloud does not use a fixed schema. Instead, every DealCloud site can have its own unique schema, with custom objects, fields, names, and relationships.

Overview

The Schema APIs allow you to retrieve detailed information about the structure of a DealCloud site and the relationship between different entities. Each site is made up of EntryTypes (also called Objects), which are like tables in a database or spreadsheet. Each EntryType contains one or more fields, which are like columns in a table.

Additionally, the APIs provide endpoints for other site-level metadata, such as timezones, currencies, units, system fields, filter operations — helpful for building robust API integrations.

These APIs do not modify the schema of the site itself — structural changes to the site's schema must be made through Object Management on the DealCloud app.

EntryTypes

Represent objects such as Company or Contact or Deal. Objects or EntryTypes are composed of one or more fields. Note, the following phrases may be used interchangably for entryType throughout the docs or API:

• EntryType
• Object
• EntryList
• List

Fields

Fields represent the individual data points within an object or EntryType, such as Name, URL, or Revenue. Each object can have multiple fields of various Field Types, allowing you to customize the schema as needed. When using the API, it’s important to handle data serialization and deserialization according to each field’s type.

Limits

Requests to the Schema APIs are limited to 5 calls per second.