Retrieve Data Extension Object Using Customer Key

This page contains information about retrieving a data extension object using the CustomerKey property.

Why Retrieve a Data Extension Object using Customer Key

You can use the CustomerKey property to pull back data from applicable data extensions. Use the information retrieved in more API calls or to filter subscribers into different groups.

How To Retrieve the Data Extension Object Using Customer Key

Use the sample code below as a model to create your own API call.

Sample .NET Code

1/**
2* Retrieve Data Extension using CustomerKey of Object.
3*/
4public void testRetrieveDataExtension()
5{
6    APIObject[] results;
7    // Create RetrieveRequest
8    RetrieveRequest rr = new RetrieveRequest();
9    rr.ObjectType = "DataExtension";
10    rr.Properties =
11        new string[]
12            {
13                "ObjectID", "CustomerKey", "Name", "IsSendable", "SendableSubscriberField.Name"
14            };
15    SimpleFilterPart filter = new SimpleFilterPart();
16    filter.Property = "CustomerKey";
17    filter.SimpleOperator = SimpleOperators.equals;
18    filter.Value = new string[]{"Testing_Forigen_Char_key"};
19    rr.Filter = filter;
20    // Execute RetrieveRequest
21    String status = soapClient.Retrieve(rr, out requestID, out results);
22    // Output the Values
23    Console.WriteLine(status);
24    Console.WriteLine(requestID);
25    Console.WriteLine(results.Length);
26    Console.WriteLine("_________Properties______________");
27}

Sample SOAP Envelopes

Request XML

1<Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
2    <RetrieveRequestMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
3        <RetrieveRequest>
4            <ObjectType>DataExtension</ObjectType>
5            <Properties>ObjectID</Properties>
6            <Properties>CustomerKey</Properties>
7            <Properties>Name</Properties>
8            <Properties>IsSendable</Properties>
9            <Properties>SendableSubscriberField.Name</Properties>
10            <Filter xsi:type="SimpleFilterPart">
11            <Property>CustomerKey</Property>
12            <SimpleOperator>equals</SimpleOperator>
13            <Value>Testing_Forigen_Char_key</Value>
14            </Filter>
15        </RetrieveRequest>
16    </RetrieveRequestMsg>
17</Body>

Response XML

1<Body xmlns:xsi="xsi">
2    <RetrieveResponseMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
3        <OverallStatus>OK</OverallStatus>
4        <RequestID>8786bab5-51ff-41b6-a485-3d24d8f43b69</RequestID>
5        <Results xsi:type="DataExtension">
6            <ObjectID>6f64f34b-4254-de11-92ee-001cc494ae9e</ObjectID>
7            <CustomerKey>Testing_Forigen_Char_key</CustomerKey>
8            <Name>Testing_Forigen_Char</Name>
9            <IsSendable>true</IsSendable>
10            <SendableSubscriberField>
11            <Name>_SubscriberKey</Name>
12            </SendableSubscriberField>
13        </Results>
14    </RetrieveResponseMsg>
15</Body>