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, notes, tasks) there is YAML document specifying available attributes, their types and properties.

Leads schema

             

              
GET/v3/leads/schema
             

             

              
HTTP/1.1 200 OKContent-Type:application/yaml; charset=UTF-8---default_sort:fields:-"display_name"-"_uid"order:"ascending"attributes:country:type:"keyword"# omitted rest of the payload
             

Deals schema

             

              
GET/v3/deals/schema
             

             

              
HTTP/1.1 200 OKContent-Type:application/yaml; charset=UTF-8---default_sort:fields:-"name"-"_uid"order:"ascending"attributes:country:type:"keyword"# omitted rest of the payload
             

Contacts schema

             

              
GET/v3/contacts/schema
             

             

              
HTTP/1.1 200 OKContent-Type:application/yaml; charset=UTF-8---default_sort:fields:-"display_name"-"_uid"order:"ascending"attributes:country:type:"keyword"# omitted rest of the payload
             

Notes schema

             

              
GET/v3/notes/schema
             

             

              
HTTP/1.1 200 OKContent-Type:application/yaml; charset=UTF-8---default_sort:fields:-"updated_at"-"_uid"order:"descending"attributes:owner:type:"permissions_owner"# omitted rest of the payload
             

Tasks schema

             

              
GET/v3/tasks/schema
             

             

              
HTTP/1.1 200 OKContent-Type:application/yaml; charset=UTF-8---default_sort:fields:-"updated_at"-"_uid"order:"descending"attributes:owner:type:"permissions_owner"# omitted rest of the payload
             

---

Query language schema

Query language schema isJSON schemadescribing request payload and corresponding protocol-level validations.

Query language Schema

             

              
GET/v3/search-schema
             

---

GraphQL schema

GraphQL schemadescribes attributes, their
types and properties available through GraphQL interface.

GraphQL Schema

             

              
GET/v3/graphql/schema