GET /rest/v1.0/custom_field_metadata
Return a list of all Custom Field Metadata associated with the Current Company.
Servers
- https://api.procore.com
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 |
---|---|---|---|
page |
Integer | No |
Page |
filterscustom_field_definitions_id |
Integer | No |
Return a list of all Custom Field Metadata associated with the Current Company and custom_field_definition_id provided. |
per_page |
Integer | No |
Elements per page |
filtersfield_set_type[] |
Array | No |
Return a list of all Custom Field Metadata associated with the Current Company and source_type provided. |
company_id |
Integer | Yes |
Unique identifier for the company. |
filtersfield_set_id[] |
Array | No |
Return a list of all Custom Field Metadata associated with the Current Company and source_id provided. |
view |
String | No |
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. The with_lov_entries returns the default attributes but adding lov_entries. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.