Search API schemas

All schemas for Search API are exposed through the API itself. There are five main documents that describe interactions with the API.

Schemas are available without authorization.

Per-index schemas

For each index (deals, leads, contacts) there is YAML document specifying available attributes, their types and properties.


Query language schema

Query language schema is JSON schema describing request payload and corresponding protocol-level validations.


GraphQL schema

GraphQL schema describes attributes, their
types and properties available through GraphQL interface.