List extension fields

The following endpoint can be used to retrieve an array of extension fields for a given type of object.

GET /:object_type/extensions/fields

Where object_type describes the object you wish to get the extension fields for. We currently support the following object types:

Parameters

Table of allowed parameters.

_fields	partial string	Allows you to specify optional fields and linked objects to include in the response.

Handling the response

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 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 field type for this value. This can be 'text','textbox','int','date','date_time','float','certify','fixed_select','flexible_select','multi_select','lookup','currency', 'hyperlink','contributor'
field_name	string	The extension structure's name assigned to it by you. e.g "My awesome custom field".
options	array	The options for 'fixed_select','flexible_select' or 'multi_select' field type.
link_type_id	unsigned int	This represents the type of the linked object type. For example, if "link_type" is job, this will be the id of the job type that these extensions can appear under.
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.

APIs

List extension fields

Analytics

Parameters

Handling the response

Related content