Find Configurable Field Set By Index
find_configurable_field_set_by_indexFind a Configurable Field Set by company ID and type; returns details or a template with null ID. Use to read custom tool configurations from Procore.
Instructions
Returns the details for a specified Configurable Field Set if found. If not, template of type Field Set will be returned with ID null. Use this to read information about Custom - Configurable Tools from Procore. 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, type. Procore API: Company Admin > Custom - Configurable Tools. Endpoint: GET /rest/v1.0/companies/{company_id}/configurable_field_sets/find_by_index
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| type | Yes | Query string parameter — the type of Configurable Field Set | |
| project_id | No | Query string parameter — project ID that is associated to the Configurable Field Set, if applicable | |
| scope__category | No | Query string parameter — category or observations_category_id are required for an Observations Configurable Field Set (0 = quality, 1 = safety, 2 = commissioning, 3 = warranty, 4 = work to complete) | |
| scope__observations_category_id | No | Query string parameter — category or observations_category_id Required for an Observations Configurable Field Set | |
| scope__inspection_type_id | No | Query string parameter — required for an Inspection Configurable Field Set. If a value is provided, only field set of the specific Inspection type is returned. If no value is provided, only field set of unassociated Inspec... | |
| scope__generic_tool_id | No | Query string parameter — required for a Generic Tool Item Configurable Field Set (type of ConfigurableFieldSet::GenericToolItem) | |
| scope__action_plan_type_id | No | Query string parameter — required for an Action Plans Plan Configurable Field Set (type of ConfigurableFieldSet::ActionPlans::Plan) | |
| page | No | Page number for paginated results (default: 1) | |
| per_page | No | Number of items per page (default: 100, max: 100) |