Requesting Raw & Custom Fields

By default all object fields are returned by an API call that communicates with an integration.

However, if you only want certain fields, then you can include a fields parameter (in the request URL parameters for REST). This parameter takes a comma-delimited list of fields for the requested object.

Raw Field (when reading data)

There is one special use-case that the fields parameter can also deliver. If you want the integration's raw object also returned, then include a raw value in the fields parameter. The raw parameter is only available on paid plans.

Raw Field (when writing data)

If you want to inject data that is currently not in the Unified data-model, you can send in a raw field when creating or updating. Data inside will be included with the create/update call to the integration's API.

Requesting custom fields

Hubspot, Salesforce and other integrations require us to request specific fields to return those fields back in our raw field. If your application requires specific fields that we do not request, such as custom fields, then you can let our list CRM APIs know with the fields parameter.

Just include the extra fields as such:

fields=raw,raw.leadfunnelstage,raw.customfield1

Prepend raw. to the field name and make sure to include the raw field in your request.

Are we missing anything? Let us know
Was this page helpful?