POST /rest/v1.0/workforce-planning/v2/companies/{company_id}/custom-fields

Creates a new Custom Field for a given company ID. Custom Fields are used to store additional information about Projects or People.

Servers

Name Type Required Description

Name	Type	Required	Description
`company_id`		Yes	Unique identifier for the company. This parameter accepts both formats: Recommended: Procore company ID (integer) - Use this for new integrations Legacy: LaborChart UUID format (uuid string) - Supported for backward compatibility A proxy layer automatically handles both formats, but using the Procore company ID is preferred for consistency with other Procore APIs.

company_id

Yes

Unique identifier for the company. This parameter accepts both formats:

Recommended: Procore company ID (integer) - Use this for new integrations
Legacy: LaborChart UUID format (uuid string) - Supported for backward compatibility

A proxy layer automatically handles both formats, but using the Procore company ID is preferred for consistency with other Procore APIs.

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Procore-Company-Id`	Integer	Yes	Unique company identifier associated with the Procore User Account.

Name	Type	Required	Description
`can_filter`	Boolean	No	If true, allows this field to be used as a filter.
`values[]`	Array	No	Only applicable for `select` or `multi-select` fields. List of values that will be options in the field's dropdown.
`name`	String	Yes	The name of the Custom Field that appears in the UI.
`description`	String	No	A description to help Admin users understand the field’s purpose.
`type`	String	Yes	The type of Custom Field. Determines the kind of data it will store. The type cannot be changed once created. Possible values: `"date"` `"text"` `"hex-color"` `"bool"` `"select"` `"currency"` `"number"` `"multi-select"` `"paragraph"`
`on_projects`	Boolean	No	If true, the field is available on Projects.
`integration_only`	Boolean	No	If true, only integrations can update this field.
`on_people`	Boolean	No	If true, the field is available on People.
`sort_by`	String	No	Only applicable for `select` or `multi-select` fields. Controls sorting of dropdown values. `alpha` sorts alphabetically, while `listed` maintains the provided order. Possible values: `"listed"` `"alpha"`

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.