Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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:

  1. Company
  2. Contact
  3. Affiliation
  4. Prospect
  5. Job
  6. Issue
  7. Contract

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.

_fieldspartial stringAllows 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.

idunsignedThe profile value id. This can be used on other endpoints that accept the profile_value_id. For example, the update extension value endpoint accepts this as a url path parameter.
   

 

 

  • No labels