CustomFieldEntityType

Users

Operations

Clients

Operations

Projects

Operations

Portfolios & Project Groups

Operations

Tasks

OperationsWebhooks

Task Comments

OperationsWebhooks

Efforts

Operations

Contacts

Operations

Companies

OperationsWebhooks

Offers

Operations

Outgoing Invoices

Operations

Incoming Invoices

Operations

Chart of Accounts

Operations

Payments

Operations

Usergroups & Teams

Operations

Suppliers

Operations

Settings

Operations

Integration

Operations

Files

Operations

Custom Fields

Operations

Webhook Management

Operations

Schemas

CustomFieldData

idstringrequired

titlestringrequired

field_namestringrequired

The field name/slug defined for your custom field

typestring(CustomFieldType)required

Enum"input""number""checkbox""select""date""link""textarea"

entity_typestring(CustomFieldEntityType)required

Enum"user""contact""company""project"

default_valuestring or integer or boolean or nullrequired

Depending on the field type, this can be a string, int, bool or null

Any of:

Depending on the field type, this can be a string, int, bool or null

string

is_filterablebooleanrequired

If true, this field can be used for filtering in the UI

is_defaultbooleanrequired

If true, this field is automatically added to all projects

show_in_listbooleanrequired

If true, this field appears as a column in list views

is_searchablebooleanrequired

If true, this field's values are included in free-text search

show_on_dashboardbooleanrequired

If true, this field is shown on the project dashboard

created_atstring(date-time)required

deleted_atstring or null(date-time)required

{
  "id": "string",
  "title": "string",
  "field_name": "string",
  "type": "input",
  "entity_type": "user",
  "default_value": "string",
  "is_filterable": true,
  "is_default": true,
  "show_in_list": true,
  "is_searchable": true,
  "show_on_dashboard": true,
  "created_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z"
}