DocumentationAdobe Campaign v8

[LIMITED AVAILABILITY]{class="badge informative" title="Restricted to Campaign Standard migrated users"}

Retrieving profiles with APIs retrieving-profiles

Last update: Fri May 03 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Developer

Retrieving profiles is performed with a GET request.

You can then refine your search by using filters, ordering and pagination. For more on this, refer to the Additional operations section.

Additionally, Campaign Standard APIs allow you to search for profiles based on one of these fields: email, first name, last name or any custom field. For more on this, refer to this section.

Sample requests

  • Sample GET request to retrieve all profiles.

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    Response to the request.

    code language-none 
    
{
    "content": [
        {
            "PKey": "<PKEY>",
            "firstName": "John",
            "lastName":"Doe",
            "birthDate": "1980-10-24",
            ...
        },
        ...
}

  • Sample GET request to retrieve the first 10 email values.

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/email?_lineCount=10 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    Response to the request. The “next” node returns the URL that gives you access to the 10 next email values.

    code language-none 
    
{
"content": [
    "amy.dakota@mail.com",
    "kristen.smith@mail.com",
    "omalley@mail.com",
    "xander.harrys@mail.com",
    "jane.summer@mail.com",
    "gloria.boston@mail.com",
    "edward.snow@mail.com",
    "dorian.simons@mail.com",
    "peter.paolini@mail.com",
    "mingam+test08@adobe.com"
],
"next": {
    "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/email?_lineCount=10&_
    lineStart=@Qy2MRJCS67PFf8soTf4BzF7BXsq1Gbkp_e5lLj1TbE7HJKqc"
}
}

Searching for profiles based on a field searching-field

The filterType parameter allows you to retrieve profiles based on one of these fields: email, first name, last name or any custom field that has been added in Advanced filtering when extending the profile resource.

NOTE
Searches are case-sensitive and performed on prefixes only. For example, you will not be able to look up for a profile using their last name’s last letters.

Sample requests

  • Sample request to filter profiles on the basis of first name.

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/byText?text=John&filterType=firstName \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

  • Sample request to filter profiles on the basis of last name.

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/byText?text=Miller&filterType=lastName \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

  • Sample request to filter profiles on the basis of email.

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/byText?text=John%40gmail.com&filterType=email \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

  • Sample request to filter profiles based on the “Hobby” custom field.

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/profile/byText?cusHobby=Dancing&filterType=Hobby \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'
recommendation-more-help
7167b251-0f24-48cd-a4e0-234fe2acbdea