Find Configurable Field Set By Index
find_configurable_field_set_by_indexRetrieve the full details of a specific configurable field set from Procore by its type and company. Returns the complete field set or a template if not found.
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 when you already know which configurable field set you want and need its full field set. company_id defaults to the value set by procore_set_config when omitted. Returns a single JSON object describing the configurable field set. Read-only — it changes nothing in Procore. Failures come back as an error payload carrying the HTTP status — commonly 401 when the token has expired, 403 without tool permission, and 404 when an id does not resolve. 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 |
|---|---|---|---|
| type | Yes | Query string parameter — the type of Configurable Field Set | |
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| 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__generic_tool_id | No | Query string parameter — required for a Generic Tool Item Configurable Field Set (type of ConfigurableFieldSet::GenericToolItem) | |
| scope__incident_type_id | No | Query string parameter — required for an Incident Configurable Field Set. If a value is provided, only field set of the specific Incident type is returned. | |
| 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__action_plan_type_id | No | Query string parameter — required for an Action Plans Plan Configurable Field Set (type of ConfigurableFieldSet::ActionPlans::Plan) | |
| scope__observations_category_id | No | Query string parameter — category or observations_category_id Required for an Observations Configurable Field Set |