UNDER DEVELOPMENT
The following endpoint can be used to retrieve an array of profile values for a given object.
GET /:object_type/:object_id/profiles/values
Where object_type and object_id describe the object you wish to get the profile values for. We currently support the following object types:
This endpoint will not load all the profile fields for a given object but merely the saved profile values the object has. For example, Job #100 may have three out of the five profile fields saved, so will only return three profile values here. If the object has no saved profiles, 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 profile value id. This can be used on other endpoints that accept the profile_value_id. For example, the update profile value endpoint accepts this as a url path parameter. |
|---|---|---|
| field_type | string | The profile structure 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". |
| value | dynamic | Visible for all types except "lookup". If date or date_time this will contain the unix timestamp for the date value. |
| value_id | unsigned | When lookup types, this will contain the appropriate id. |
| value_type | string | When lookup this will contain the lookups type. e.g, "company" |
| link_id | unsigned | If the ID of the object the profile value is against. |
| link_table | string | The type of object the profile is against. e.g, job, contract, prospect or issue. |
| date_modified | unix timestamp | Unix timestamp of the date this profile was last updated. |
| structure_id | unsigned | The extension structure id the profile value belongs to. |