List Custom Field Definitions
list_custom_field_definitions_companyRead-onlyIdempotent
Retrieve a paginated list of custom field definitions for a company to enumerate configurable tools, locate IDs, or apply filters. Required: company_id.
Instructions
Return a list of Custom Field Definitions for a given company. 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 (v1.1): Company Admin > Custom - Configurable Tools. Endpoint: GET /rest/v1.1/companies/{company_id}/custom_field_definitions
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — items per page, default: 100, max: 100 | |
| 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 | |
| filters__id | No | Query string parameter — return custom field definitions that are filtered on an array of ID's. Example: filters[id]=[1,2] | |
| sort | No | Query string parameter — direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter. |