Custom Fields Mapping

Custom Fields Mapping describes how custom fields seen by user (e.g. contact custom field Role in organisation) are mapped to custom field objects in Search API backend (e.g. contact:12345).

Custom Fields Mapping API returns list of all custom fields defined on account for given entity (lead/contact/deal), alongside with additional meta-information (custom field type, id to use within search API, user-provided name).

Endpoints

There is one mapping API endpoint for each entity type:

Endpoint Action Response payload Description
/v3/deals/custom_fields GET JSON Deal custom fields mapping
/v3/leads/custom_fields GET JSON Lead custom fields mapping
/v3/contacts/custom_fields GET JSON Contact custom fields mapping

Schema

Custom fields

CustomField type consists of following attributes:

Attribute Type Description
id string ID of this custom field in Base backend systems
name string User-defined custom field name, e.g. Role in organisation
type string Type of this custom field, see custom field type in firehose section
resource_type string Type of entity this custom field is defined for, possible values are lead, deal and contact, prospect_and_customer
search_api_id string Search API attribute id to use with Search API to e.g. sort on this custom field

Use with Search API

Custom field IDs obtained through Mapping API may be used to query Search API