Skip to contentSkip to navigationSkip to topbar

Retrieve a Data Mapping


(information)

Legal information

Conversation Memory, including the APIs, may use artificial intelligence or machine learning technologies and is subject to the terms of the Predictive and Generative AI/ML Features Addendum(link takes you to an external page). For more details on AI usage and data, see the AI Nutrition Facts.

Conversation Memory is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI.

Conversation Memory is not intended for use with sensitive information about individuals. Twilio does not control what information comes from conversation channels and relies on you to ensure the data in customer profiles aligns with our acceptable use policy. Twilio does have limited guardrails in the form of a prompt exclusion that is designed to provide a minimal screening against inclusion of GDPR special category data(link takes you to an external page). As a reminder our profile technology uses generative artificial intelligence. Because generative artificial intelligence can make mistakes, review all outputs to ensure that the profile is correct.

Conversations products are only available in the new Twilio Console(link takes you to an external page). If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

GET/v1/ControlPlane/Stores/{storeId}/DataMappings/{dataMappingId}

Base url: https://memory.twilio.com (base url)

Retrieve the details of a specific data mapping by its unique ID.


Request

fetch-data-mapping-request page anchor

Authentication

authentication page anchor
Property nameTypeRequiredPIIDescription
storeIdstring
required
Not PII

A unique Memory Store ID using Twilio Type ID (TTID) format

Example: mem_store_00000000000000000000000000Pattern: ^mem_(store|service)_[0-7][0-9a-z]{25}$

dataMappingIdstring
required

A unique DataMapping ID using Twilio Type ID (TTID) format

Example: mem_datamapping_00000000000000000000000000Pattern: ^mem_datamapping_[0-7][0-9a-z]{25}$

200400404429500503

Data mapping details retrieved successfully.

Schema
Property nameTypeRequiredPIIDescriptionChild properties
displayNamestring

Optional

Name of the data mapping.

Example: crm-contactsPattern: ^[a-zA-Z][a-zA-Z0-9-_.]*$Min length: 1Max length: 128

descriptionstring

Optional

A human readable description of this resource, up to 512 characters.

Example: Syncs customer data from CRM dataset to profile traitsMin length: 1Max length: 512

isEnabledboolean

Optional

Flag indicating whether the data mapping is active. When true, data will be ingested and mapped according to the configuration. When false, the data mapping will be inactive and no data will be ingested into the Memory Store.

Default: trueExample: true

mappingTo
oneOf:

Optional

Details of where to map data items to. Each data mapping to type has its own set of configuration parameters and destination specific properties.

Example: {"type":"TRAITS","mappings":[{"fieldName":"primary_email","traitGroup":"Contact","traitName":"email"}]}

mappingFrom
oneOf:

Optional

Details of where to map data items from. Each data mapping from type has its own set of configuration parameters and source specific properties.

Example: {"type":"DATASET","datasetId":"tdi_dataset_00000000000000000000000000"}

idstring

Optional

The unique identifier for the data mapping.

Example: mem_datamapping_00000000000000000000000000Pattern: ^mem_datamapping_[0-7][0-9a-z]{25}$

createdAtstring<date-time>

Optional

The ISO 8601 timestamp when the data mapping was created.

Example: 2026-01-15T10:30:00Z

updatedAtstring<date-time>

Optional

The ISO 8601 timestamp when the data mapping was last updated.

Example: 2026-01-15T11:45:00Z

versioninteger

Optional

The current version number of the DataMapping. Incremented on each successful update.

Example: 3Minimum: 1
Retrieve a Data MappingLink to code sample: Retrieve a Data Mapping
1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function fetchDataMapping() {
11
const dataMapping = await client.memory.v1
12
.dataMappings(
13
"mem_store_00000000000000000000000000",
14
"mem_datamapping_00000000000000000000000000"
15
)
16
.fetch();
17
18
console.log(dataMapping.displayName);
19
}
20
21
fetchDataMapping();

Response

Note about this response
1
{
2
"createdAt": "2009-07-06T20:30:00Z",
3
"description": "description",
4
"displayName": "crm-contacts",
5
"id": "mem_datamapping_00000000000000000000000000",
6
"isEnabled": true,
7
"mappingFrom": {},
8
"mappingTo": {},
9
"updatedAt": "2009-07-06T20:30:00Z",
10
"version": 3
11
}