--- title: "Custom Field Mapping for Unified APIs" description: "Map platform-specific and customer-created fields onto the Apideck unified model. Values come back in custom_mappings on every response, and customers can map their own fields in Vault." url: "https://www.apideck.com/custom-field-mapping" section: "Platform" --- # Custom Field Mapping for Unified APIs Map platform-specific and customer-created fields onto the Apideck unified model. Values come back in custom_mappings on every response, and customers can map their own fields in Vault. ## 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 [View guide](https://developers.apideck.com/guides/field-mapping) ![Sage HR](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Fimage%2Fupload%2Fv1634905030%2Ficons%2Fsage-hr.jpg\&w=96\&q=75) `date_of_birth` ![Officient](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Fimage%2Fupload%2Fv1565297165%2Fcatalog%2Fofficient-io%2Ficon128x128.jpg\&w=96\&q=75) `birthdate` ![HiBob](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Fimage%2Fupload%2Fv1610129717%2Ficons%2Fhibob.jpg\&w=96\&q=75) `shortBirthDate` ![Apideck](https://www.apideck.com/_next/image?url=https%3A%2F%2Fwww.apideck.com%2Ffavicon.ico\&w=96\&q=75) `date_of_birth|` ![BambooHR](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Fimage%2Fupload%2Fv1531304444%2Fcatalog%2Fbamboohr%2Ficon128x128.png\&w=96\&q=75) `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](https://developers.apideck.com/guides/field-mapping)[Configure guide](https://help.apideck.com/en/articles/4231554) ### Standard Fields Common fields available across all integrations `id``first_name``last_name``email``created_at` ### Integration Fields Platform-specific fields unique to each service `hs_analytics_timestamp``LastReferencedDate``won_deals_count` ### Custom Fields User-defined fields created within the platform `T_shirt_Size__c``t_shirt_size``custom_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 icon](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Fimage%2Fupload%2Fv1529456047%2Fcatalog%2Fsalesforce%2Ficon128x128.png\&w=96\&q=75) ### 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 icon](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Fimage%2Fupload%2Fv1529456047%2Fcatalog%2Fhubspot%2Ficon128x128.png\&w=96\&q=75) ### 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 icon](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Fimage%2Fupload%2Fv1529456047%2Fcatalog%2Fpipedrive%2Ficon128x128.png\&w=96\&q=75) ### 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. 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. 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. 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](https://developers.apideck.com/guides/field-mapping). ## Build integrations without the headaches Every integration works differently. Our field mapping ensures your customers' data flows perfectly, no matter the source ### Unified Data Schema Transform diverse API responses into a consistent format, regardless of the underlying platform structure. ### Custom Field Support Map platform-specific custom fields to your unified schema, ensuring no customer data is lost. ### Real-time Processing Field mappings are applied during the API call itself, and the mapped data is never stored. ### Data Validation Built-in validation ensures data integrity and prevents errors during field transformation. ### Developer-Friendly Configure mappings through intuitive UI or programmatically via APIs with comprehensive SDKs. ### Schema Flexibility Support for complex nested objects, arrays, and flexible mapping rules across all data types. [View developer guide](https://developers.apideck.com/guides/field-mapping) One common model\ for all your data ----------------- We normalize messy, inconsistent APIs into a single structure, while still exposing the raw downstream information for maximum convenience. ### Accounting ![QuickBooks](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fquickbooks\&w=64\&q=75) ![Xero](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fxero\&w=64\&q=75) ![NetSuite](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fnetsuite\&w=64\&q=75) ![Sage Intacct](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fsage-intacct\&w=64\&q=75) +52 56 integrations ### CRM ![HubSpot](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fhubspot\&w=64\&q=75) ![Salesforce](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fsalesforce\&w=64\&q=75) ![Pipedrive](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fpipedrive\&w=64\&q=75) ![Microsoft Dynamics CRM](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fmicrosoft-dynamics\&w=64\&q=75) +18 22 integrations ### Ecommerce ![Shopify](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fshopify\&w=64\&q=75) ![BigCommerce](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fbigcommerce\&w=64\&q=75) ![WooCommerce](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fwoocommerce\&w=64\&q=75) ![Magento](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fmagento\&w=64\&q=75) +13 17 integrations ### ATS ![Greenhouse](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fgreenhouse\&w=64\&q=75) ![Lever](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Flever\&w=64\&q=75) ![Workable](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fworkable\&w=64\&q=75) ![SAP SuccessFactors](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fsap-successfactors-new\&w=64\&q=75) +5 9 integrations ### Issue tracking ![Jira](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fjira\&w=64\&q=75) +8 9 integrations ### File storage ![OneDrive](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fonedrive\&w=64\&q=75) ![Google Drive](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fgoogle-drive\&w=64\&q=75) ![Dropbox](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fdropbox\&w=64\&q=75) ![SharePoint](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fsharepoint\&w=64\&q=75) ![Box](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fbox\&w=64\&q=75) 5 integrations ### HRIS ![Workday](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fworkday\&w=64\&q=75) ![BambooHR](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fbamboohr\&w=64\&q=75) ![Hibob (Legacy)](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fhibob\&w=64\&q=75) ![SAP SuccessFactors](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fsap-successfactors-new\&w=64\&q=75) +53 57 integrations ![Apideck](https://www.apideck.com/_next/image?url=%2Fapideck-icon.png\&w=96\&q=75) ### Your product ### Accounting ![QuickBooks](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fquickbooks\&w=64\&q=75) ![Xero](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fxero\&w=64\&q=75) ![NetSuite](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fnetsuite\&w=64\&q=75) ![Sage Intacct](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fsage-intacct\&w=64\&q=75) +52 56 integrations ### CRM ![HubSpot](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fhubspot\&w=64\&q=75) ![Salesforce](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fsalesforce\&w=64\&q=75) ![Pipedrive](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fpipedrive\&w=64\&q=75) ![Microsoft Dynamics CRM](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fmicrosoft-dynamics\&w=64\&q=75) +18 22 integrations ### HRIS ![Workday](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fworkday\&w=64\&q=75) ![BambooHR](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fbamboohr\&w=64\&q=75) ![Hibob (Legacy)](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fhibob\&w=64\&q=75) ![SAP SuccessFactors](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fsap-successfactors-new\&w=64\&q=75) +53 57 integrations ### Ecommerce ![Shopify](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fshopify\&w=64\&q=75) ![BigCommerce](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fbigcommerce\&w=64\&q=75) ![WooCommerce](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fwoocommerce\&w=64\&q=75) ![Magento](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fmagento\&w=64\&q=75) +13 17 integrations ### File storage ![OneDrive](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fonedrive\&w=64\&q=75) ![Google Drive](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fgoogle-drive\&w=64\&q=75) ![Dropbox](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fdropbox\&w=64\&q=75) ![SharePoint](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fsharepoint\&w=64\&q=75) ![Box](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fbox\&w=64\&q=75) 5 integrations ### Issue tracking ![Jira](https://www.apideck.com/_next/image?url=https%3A%2F%2Fres.cloudinary.com%2Fapideck%2Ficons%2Fjira\&w=64\&q=75) +8 9 integrations ![Apideck](https://www.apideck.com/_next/image?url=%2Fapideck-icon.png\&w=96\&q=75) ### Your product ## Custom field mapping FAQ Common questions about mapping custom fields across unified API connectors * * What is custom field mapping in a unified API? * What is the difference between property mapping and custom field mapping? * Where do mapped fields appear in the API response? * Can my customers map their own custom fields? * Can I manage field mappings through the API? * Does Apideck store the mapped data?