List Extension Values

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

GET /:object_type/:object_id/extensions/values

Where object_type and object_id describe the object you wish to get the extension values for. We currently support the following object types:

This endpoint will not load all the extension structures for a given object but merely the saved extension values the object has. For example, Job #100 may have three out of the five extension structures saved, so will only return three extension values here. If the object has no saved extensions, this endpoint will return an empty array.

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 value 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 type for this value. This can be 'text', 'textbox', 'int', 'date', 'date_time', 'float', 'certify', 'fixed_select', 'flexible_select', 'multi_select', 'lookup', 'currency', 'hyperlink' or 'contributor'
field_name	string	The extension structure's name assigned to it by you. e.g "My awesome custom field".
value	dynamic	Please refer to the following details on when this type is applied When field_type is int, this will return an integer When field type is date or date_time, this value will return a unix timestamp All other types excluding certify, lookup and contributor will store their textual value in here
value_int	int	When type is certify this value will contain an integer
value_id	unsigned	When lookup or contributor types, this will contain the appropriate id.
value_type	string	When lookup this will contain the lookups type
value_date	unix timestamp	Visible for date, date_time and certify extension types.
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.
date_modified	unix timestamp	Unix timestamp of the date this extension was last updated.
structure_id	unsigned	The extension structure id the extension value belongs to. DEPRECATED on 16th Oct 2014, please use field_id
field_id	unsigned	The extension structure id the extension value belongs to.
is_sensitive	int, 0 for false, 1 for true	Only accessible to those with view sensitive extension values permission
is_important	int, 0 for false, 1 for true
is_exported	int, 0 for false, 1 for true
default_value	string	The default value assigned to this extension values structure.
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.