...
Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields
parameter; see included examples. Underlined values are default.
id | unsigned | The extension structure field id. This can be used on other endpoints that accept the extension_value_id. For example, the update extension value endpoint accepts this as a url path parameter. |
---|---|---|
field_type | string | The extension structure field type for this value. This can be 'text', 'integer', 'decimal', 'date', 'date_time', 'currency', 'lookup', 'structure', 'select', 'multi_select', 'hyperlink |
field_name | string | The extension structure's name assigned to it by you. e.g "My awesome custom field". |
link_id | unsigned | If the ID of the object the extension value is against. |
link_type | string | The type of object the extension is against. e.g, job, contract, prospect or issue. |
required | string | This indicates whether this extension field is required for the object. |
lookup_type | string | When lookup this will contain the lookups type. e.g, "company" |
exported | string | This indicates whether this extension field can be exported. |
important | string | This indicates whether this extension field is an important field. |
default_value | string | The default value of this extension field. |
information | string | Information about this extension field. |