Custom Fields

Custom fields allow you to use unique categorizations that are not available in Productive's default settings, allowing you to organize data based on your specific criteria and use it throughout the app.

For more details on how to work with custom fields please refer to Working with custom fields guide.

Aggregation type

The aggregation_type_id attribute can have one of the following integer values:

  • 1 (sum)
  • 2 (avg)

Customizable type

The customizable_type attribute can have one of the following string values:

  • deals
  • projects
  • companies
  • budgets
  • invoices
  • tasks
  • projects
  • bookings
  • project_expenses
  • services
  • employees
  • contacts
  • pages
  • survey_responses

Data type

The data_type_id attribute can have one of the following integer values:

  • 1 (Text field)
  • 2 (Number field)
  • 3 (Select field)
  • 4 (Date field)
  • 5 (Multiple select field)
  • 6 (Person field)
  • 7 (Attachment field)

Formatting type

The formatting_type_id attribute can have one of the following integer values:

  • 1 (decimal)
  • 2 (percentage)

Attributes

aggregation_type_id integer
Response Request Enum

ID of the aggregation type defining how values of this custom field are aggregated in reports.

Enum Values (2 values)

  • 1
    SUM
  • 2
    AVG
archived boolean
Parameter `filter`

Whether this custom field has been archived.

archived_at string
Response

Timestamp when this custom field was archived, or null if not archived.

created_at string
Response

Timestamp when this custom field was created.

custom_field_people array of person
Response

People associated with this custom field via person-type values.

customizable_type string
Response Request Parameter `filter`

The type of resource this custom field is attached to (e.g. tasks, projects, people).

data_type_id integer
Response Request Enum

ID of the data type that determines what kind of value this custom field stores (e.g. text, number, date).

Enum Values (7 values)

  • 1
    Text field
  • 2
    Number field
  • 3
    Select field
  • 4
    Date field
  • 5
    Multiple select field
  • 6
    Person field
  • 7
    Attachment field
formatting_type_id integer
Response Request Enum

ID of the formatting type that controls how this custom field's value is displayed.

Enum Values (2 values)

  • 1
    Decimal
  • 2
    Percentage
global boolean
Response Request Parameter `filter`

Whether this custom field is available globally across all projects, rather than scoped to a specific project.

name string
Response Request Parameter `filter`

The display name of this custom field.

options array of custom field option
Response

The selectable options available for this custom field, applicable for dropdown and multi-select types.

organization organization
Response

The organization this custom field belongs to.

position integer
Response Request

The display order position of this custom field within its section.

project project
Response

The project this custom field is scoped to, or null if it is a global field.

project_id integer
Request Parameter `filter`

ID of the project this custom field is scoped to, or null if it is a global field.

quick_add_enabled boolean
Response Request

Whether this custom field appears in quick-add forms for faster data entry.

required boolean
Response Request

Whether a value for this custom field is required when creating or editing the associated resource.

section custom field section
Response

The custom field section this field belongs to for grouping in the UI.

section_id integer
Request

ID of the custom field section this field belongs to.

sensitive boolean
Response Request

Whether this custom field is sensitive and its values are restricted to authorized users.

show_in_add_edit_views boolean
Response Request Parameter `filter`

The show in add edit views.

survey survey
Response

The survey this custom field is associated with, if it was created from a survey response field.

survey_id integer
Request Parameter `filter`

ID of the survey this custom field is associated with.

updated_at string
Response

Timestamp when this custom field was last updated.

Examples

Loading example