Schema APIs

The Schema APIs are designed to help you understand the site. A site is composed of EntryTypes (aka objects/tables), and each entryType contains 1 or more fields.

EntryTypes can be thought of as tables in a tradition database construct. Examples of entryTypes you may see in a site are Company, Contact, etc. EntryTypes can have many fields. A DealCloud site has a limited number of fieldTypes, but a entryType can have as many fields and fieldType combination as needed.

Fields can be thought of as columns in a traditional database construct. Fields are where data is stored. When working with the API, you will need to know how to serialize and deserialize data based on the fieldType used to store the information.

Using the Schema APIs, you will be able to determine the full schema of a given site. This includes all entryTypes, all fields for a given entryType, all relationships between entry types, etc.

Along with entryTypes and Fields, the Schema APIs also contains endpoints for other system level information that would be important for successful API integrations. These endpoints provide metadata about things like timezones, currencies, units, system fields, users, filter operations etc. for a given DealCloud site.

Swagger

Limits

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