UNDER DEVELOPMENT
The following endpoint can be used to retrieve an array of profile fields for a given type of object.
GET /:object_type/profiles/fields
Where object_type describes the object you wish to get the profile 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 profile field 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". |
| link_id | unsigned | If the ID of the object the profile value is against. |
| link_type | string | The type of object the profile is against. e.g, job, contract, prospect or issue. |
| required | string | This indicates whether this profile 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 profile field can be exported. |
| descrioption | string | The description about this profile field. |