GET /rest/v1.0/custom_field_definitions/{id}

Returns the details for a specified Custom Field Definition

Servers

Path parameters

Name Type Required Description
id Integer Yes

Custom Field Definition ID

Request headers

Name Type Required Description
Procore-Company-Id Integer Yes

Unique company identifier associated with the Procore User Account.

Query parameters

Name Type Required Description
includes_configurable_field_sets_count Boolean No

If true, response will include the number of field sets using item (custom field).

Default value: false

company_id Integer Yes

Unique identifier for the company.

view String No

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 extended.

Possible values:

  • "extended"
  • "with_lov_entries"
  • "default"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.