List Custom Field Definitions
list_custom_field_definitions_v1_0Read-onlyIdempotent
Enumerate custom field definitions for a company with paginated results. Filter by tool name, label, scope, and sort options to find definitions.
Instructions
DEPRECATED This endpoint has been deprecated, it will be sunset at 9/1/2024. Instead, please use rest/v1.1/companies/{company_id}/custom_field_definitions. Use this to enumerate Custom - Configurable Tools when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Custom - Configurable Tools. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: company_id. Procore API: Company Admin > Custom - Configurable Tools. Endpoint: GET /rest/v1.0/custom_field_definitions
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | Query string parameter — unique identifier for the company. | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| view | No | Query string parameter — 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 | Query string parameter — the name of the company/project level tool that is allowed read permissions to custom field definitions. | |
| includes_configurable_field_sets_count | No | Query string parameter — if true, response will include the number of field sets using item (custom field). | |
| filters__with_label | No | Query string parameter — return custom field definitions that label contains text | |
| scope__type | No | Query string parameter — return custom field definitions that contains fieldset type | |
| scope__category | No | Query string parameter — return custom field definitions that contains category | |
| scope__observations_category_id | No | Query string parameter — return custom field definitions that contains observations_category_id | |
| scope__inspection_type_id | No | Query string parameter — return custom field definitions that contains inspection_type_id | |
| scope__generic_tool_id | No | Query string parameter — return custom field definitions that contains generic_tool_id | |
| scope__action_plan_type_id | No | Query string parameter — return custom field definitions that contains action_plan_type_id | |
| sort | No | Query string parameter — direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter. |