GET /rest/v1.1/companies/{company_id}/custom_field_definitions
Return a list of Custom Field Definitions for a given company.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
company_id |
Integer | Yes |
Unique identifier for the company. |
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 |
filters[id][] |
Array | No |
return custom field definitions that are filtered on an array of ID's. Example: filters[id]=[1,2] |
tool_name |
String | No |
The name of the company/project level tool that is allowed read permissions to custom field definitions. Possible values:
|
per_page |
Integer | No |
Items per page, default: 100, max: 100 |
sort |
String | No |
Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter. Possible values:
|
includes_configurable_field_sets_count |
Boolean | No |
If true, response will include the number of field sets using item (custom field). Default value: false |
filters[with_label] |
String | No |
Return custom field definitions that label contains text |
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.