The Embedded Finance Index is live: 6,292 companies and 1,383 providers, mapped across the stack. Explore the Index →

Custom Field MappingYour data, your way

Every platform, and every customer, names fields differently. Map platform-specific and customer-created fields onto the unified model once, and read them from the same key on every connector.

Map any raw response field
Customers map their own fields
Manage mappings via API

Get started for free View guide

date_of_birth

birthdate

shortBirthDate

date_of_birth|

dateOfBirth

Every API speaks a different language

API integrations present data in diverse formats with different field names, structures, and data types. Field mapping standardizes this chaos into a unified format.

Developer guide Configure guide

Standard Fields

Common fields available across all integrations

idfirst_namelast_nameemailcreated_at

Integration Fields

Platform-specific fields unique to each service

hs_analytics_timestampLastReferencedDatewon_deals_count

Custom Fields

User-defined fields created within the platform

T_shirt_Size__ct_shirt_sizecustom_priority_level

Stop wrestling with messy data formats

Every platform stores the same data differently. We handle the chaos so you can focus on building features

Salesforce

Custom fields end with __c and are part of the root object

JSON

{
  "Id": "123",
  "FirstName": "Jane",
  "LastName": "Doe",
  "T_shirt_Size__c": "Medium",
  "Assigned_CSM__c": "Tom S.",
  "CreatedDate": "2019-07-09T19:35:03.000Z"
}

HubSpot

All fields including custom ones are nested in properties object

JSON

{
  "id": "123",
  "properties": {
    "firstname": "Jane",
    "lastname": "Doe",
    "t_shirt_size": "Medium",
    "assigned_csm": "Tom S.",
    "lifecyclestage": "lead"
  },
  "createdAt": "2019-07-09T19:35:03.000Z"
}

Pipedrive

Custom fields have unique keys and are nested in the data object

JSON

{
  "data": {
    "id": "d2b4f0b0-6219-11eb-84bd-4b223d902a50",
    "first_name": "Jane",
    "last_name": "Doe",
    "c692e0f58789dfebb3adba15721": "Medium",
    "e24805787eef64b08aafb6fa3d8": "Tom S."
  }
}

Map any field from any platform

Map platform-specific fields and custom user data with precision and flexibility

Property Mapping

Maps fields directly from the raw integration response to your unified schema. Perfect for platform-specific fields that aren't part of the standard unified model.

properties.lifecyclestage

custom_mappings.lifecycle_stage

Custom Field Mapping

Maps user-created custom fields from the custom_fields array in the response. Ideal for customer-specific fields that vary between different user accounts.

custom_fields.t_shirt_size

custom_mappings.tshirt_size

How custom field mapping works

Field mapping extends the Apideck unified model with fields it does not cover. Mapped values come back in a custom_mappings object on the same unified response, under the keys you chose, for every connector you mapped.

1
Define the field once
In your Apideck dashboard, add a field to the unified model with its own key, such as lifecycle_stage or tshirt_size. That key is what your code reads, whichever platform the data comes from.
2
Choose where each connector reads it from
Per connector, point the field at a property in the raw response (property mapping) or at one of the custom fields Apideck already returns (custom field mapping). When a connector makes several downstream requests to build a response, you pick the request to read from.
3
Let customers map their own fields
When only your customer knows which field holds the value, they pick it themselves in Vault while connecting. You can also set or change a mapping for a customer through the Vault API custom mappings endpoints.

GET /crm/contacts/551 with two mapped fields

{
  "service": "hubspot",
  "resource": "contacts",
  "data": {
    "id": "551",
    "first_name": "Emilia",
    "last_name": "Earhart",
    "custom_fields": [
      { "id": "t_shirt_size", "value": "Small" }
    ],
    "custom_mappings": {
      "lifecycle_stage": "lead",
      "tshirt_size": "Small"
    }
  }
}

Step-by-step setup with screenshots is in the field mapping guide.