Developer
Documentation
Resources
Get Support
Sign in
Developer
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Developer
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Classes
Enumerations
Interfaces
TypeAliases

CompassCustomFieldDefinitionsQuery

The query for retrieving custom field definitions on a Compass site.

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to retrieve custom field definitions from.
componentTypeIdsInputMaybe<Array<String>>Optional filter to search for custom field definitions applied to any of the specific component types. Returns all custom field definitions by default.
componentTypesInputMaybe<Array<CompassComponentType>>Optional filter to search for custom field definitions applied to any of the specified component types. Returns all custom field definitions by default.

Rate this page: