Sign in
CustomFieldDefinition

Retrieves the active custom field definitions mapped to an entity type, in display order, including data type, multi-select flag, required flag, visibility, and the active options for Dropdown fields. Use the returned CustomFieldDefinitionID (or Name) to set values via the CustomFields collection on the Task and Project endpoints. Returns an empty list when the account's Custom Fields feature is disabled.

get/api/CustomFieldDefinition

Query parameters

EntityTypeCodestring

The entity type the fields are mapped to. Values: Project, Task, TeamMember, Contact, Company, Timesheet, Expense, Invoice, InvoiceLineItem, Estimate, EstimateLineItem, Schedule, Bill, BillLineItem. Required.

Response

Returns the active custom field definitions mapped to the entity type (empty when the feature is disabled).

Changes

Changed in 1 of the 3 revisions of this API.1