Skip to main content

List Field Schema

POST 
/v1/crm/field-schema/list

Lists the field schemas for a CRM object type, including custom fields. Set crmObjectType: omitting it matches no schema and comes back as an empty list rather than an error. To list the schemas for every object type in the namespace, send the literal wildcard "". Each schema's field id is what builds the fields.<fieldId> paths used in CRM object update field masks and returned by the get and list endpoints. A schema's external id is a second identifier for the same field, partner-defined for custom fields and of the form standard__ for Vendasta's built-ins; it can be sent in place of the field id inside a FieldValue (the field id wins when both are set), and a CRM object update mask accepts it as well: update masks match a bare field id, a bare external id, or either of those prefixed as fields.<...>. Read masks on the get endpoints are narrower and require the fields. prefix. Archived schemas are never returned by this endpoint. crmObjectSubtype and filters.namespace narrow the results further.

Request​

Responses​

A successful response.