List Custom Field Metadata
list_custom_field_metadataRead-onlyIdempotent
Retrieve a paginated list of custom field metadata for a company or project. Use to find IDs, filter by field set type or ID, and control pagination.
Instructions
Return a list of all Custom Field Metadata associated with the Current 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. Procore API: Company Admin > Custom - Configurable Tools. Endpoint: GET /rest/v1.0/custom_field_metadata
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | No | Query string parameter — unique identifier for the company. You must supply either a company_id or project_id. | |
| project_id | No | Query string parameter — unique identifier for the project. You must supply either a company_id or project_id. | |
| 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 attributes company_id, host_type, source_type, source_id, label, data_type. T... | |
| filters__field_set_type__ | No | Query string parameter — return a list of all Custom Field Metadata associated with the Current Company and source_type provided. | |
| filters__field_set_id__ | No | Query string parameter — return a list of all Custom Field Metadata associated with the Current Company and source_id provided. | |
| filters__custom_field_definitions_id | No | Query string parameter — return a list of all Custom Field Metadata associated with the Current Company and custom_field_definition_id provided. |