list_custom_field_definitions
Retrieve custom field definitions from Procore to configure and manage project data fields for company administration and tools.
Instructions
List Custom Field Definitions. [Company Admin/Custom - Configurable Tools] GET /rest/v1.0/custom_field_definitions
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | Unique identifier for the company. | |
| page | No | Page | |
| per_page | No | Elements per page | |
| view | No | The extended view provides what is shown below. The default view returns the same as the extended view but excludes the attribute custom_field_lov_entries. The with_lov_entries view is the same as ... | |
| tool_name | No | The name of the company/project level tool that is allowed read permissions to custom field definitions. | |
| includes_configurable_field_sets_count | No | If true, response will include the number of field sets using item (custom field). | |
| filters__with_label | No | Return custom field definitions that label contains text | |
| scope__type | No | Return custom field definitions that contains fieldset type | |
| scope__category | No | Return custom field definitions that contains category | |
| scope__observations_category_id | No | Return custom field definitions that contains observations_category_id | |
| scope__inspection_type_id | No | Return custom field definitions that contains inspection_type_id | |
| scope__generic_tool_id | No | Return custom field definitions that contains generic_tool_id | |
| scope__action_plan_type_id | No | Return custom field definitions that contains action_plan_type_id | |
| sort | No | Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter. |