Skip to main content

Get a model's custom-field definitions

GET 
/custom-field-definitions

The workspace's custom-field definitions on one model (contact, company, deal, product, or task), each in full — data type, storage type, picklist options, required flag, position and timestamps. Custom fields only; for the complete field catalog (system fields included, with filter/sort metadata) use GET /custom-fields. Read access requires any contact, company, or deal scope (read/write/all) — no dedicated scope exists, and the same scopes cover every model above.

Request​

Responses​

The model's custom-field definitions