Developers
API References
Data Subject Request API

Data Subject Request API Version 1 and 2

Data Subject Request API Version 3

Platform API

Key Management

Platform API Overview

Accounts

Apps

Audiences

Calculated Attributes

Data Points

Feeds

Field Transformations

Services

Users

Workspaces

Warehouse Sync API

Warehouse Sync API Overview

Warehouse Sync API Tutorial

Warehouse Sync API Reference

Data Mapping

Warehouse Sync SQL Reference

Warehouse Sync Troubleshooting Guide

ComposeID

Warehouse Sync API v2 Migration

Bulk Profile Deletion API Reference

Calculated Attributes Seeding API

Custom Access Roles API

Data Planning API

Group Identity API Reference

Pixel Service

Profile API

Events API

mParticle JSON Schema Reference

IDSync

Client SDKs
AMP

AMP SDK

Android

Initialization

Configuration

Network Security Configuration

Event Tracking

User Attributes

IDSync

Screen Events

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Push Notifications

WebView Integration

Logger

Preventing Blocked HTTP Traffic with CNAME

Linting Data Plans

Troubleshooting the Android SDK

API Reference

Upgrade to Version 5

Cordova

Cordova Plugin

Identity

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

Flutter

Getting Started

Usage

API Reference

iOS

Workspace Switching

Initialization

Configuration

Event Tracking

User Attributes

IDSync

Screen Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Push Notifications

Webview Integration

Upload Frequency

App Extensions

Preventing Blocked HTTP Traffic with CNAME

Linting Data Plans

Troubleshooting iOS SDK

Social Networks

iOS 14 Guide

iOS 15 FAQ

iOS 16 FAQ

iOS 17 FAQ

iOS 18 FAQ

API Reference

Upgrade to Version 7

React Native

Getting Started

Identity

Roku

Getting Started

Identity

Media

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

Xbox

Getting Started

Identity

Web

Initialization

Configuration

Content Security Policy

Event Tracking

User Attributes

IDSync

Page View Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Custom Logger

Persistence

Native Web Views

Self-Hosting

Multiple Instances

Web SDK via Google Tag Manager

Preventing Blocked HTTP Traffic with CNAME

Facebook Instant Articles

Troubleshooting the Web SDK

Browser Compatibility

Linting Data Plans

API Reference

Upgrade to Version 2 of the SDK

Xamarin

Getting Started

Identity

Alexa

Media SDKs

Android

iOS

Web

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Quickstart
HTTP Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Android

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Step 9. Test your local app

iOS Quick Start

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Java Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Node Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Python Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Web

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Tools

mParticle Command Line Interface

Linting Tools

Smartype

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

Compose ID

Data Hosting Locations

Glossary

Rules Developer Guide

Migrate from Segment to mParticle

Migrate from Segment to mParticle

Migrate from Segment to Client-side mParticle

Migrate from Segment to Server-side mParticle

Segment-to-mParticle Migration Reference

API Credential Management

The Developer's Guided Journey to mParticle

Guides
Customer 360

Overview

User Profiles

Overview

User Profiles

Group Identity

Overview

Create and Manage Group Definitions

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Predictive Attributes

What are predictive attributes?

Predict Future Behavior

Create Future Prediction

Use Future Predictions in Campaigns

Assess and Troubleshoot Predictions

Next Best Action

Next Best Action Overview

Create a Next Best Action (NBA)

View and Manage NBAs

Activate Next Best Actions in Campaigns

Getting Started

Create an Input

Start capturing data

Connect an Event Output

Create an Audience

Connect an Audience Output

Transform and Enhance Your Data

Segmentation
New Audiences Experience

Audiences Overview

Create an Audience

Connect an Audience

Manage Audiences

FAQ

Classic Audiences Experience

Real-time Audiences (Legacy)

Standard Audiences (Legacy)

Journeys

Journeys Overview

Manage Journeys

Download an audience from a journey

Audience A/B testing from a journey

New vs. Classic Experience Comparison

Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

Platform Guide
Billing

Usage and Billing Report

The New mParticle Experience

The new mParticle Experience

The Overview Map

Observability

Observability Overview

Observability User Guide

Observability Troubleshooting Examples

Observability Span Glossary

Platform Settings

Key Management

Event Forwarding

Notification Center (Early Access)

System Alerts

Trends

Introduction

Data Retention

Data Catalog

Connections

Activity

Data Plans

Live Stream

Filters

Rules

Blocked Data Backfill Guide

Tiered Events

mParticle Users and Roles

Analytics Free Trial

Troubleshooting mParticle

Usage metering for value-based pricing (VBP)

IDSync

IDSync Overview

Use Cases for IDSync

Components of IDSync

Store and Organize User Data

Identify Users

Default IDSync Configuration

Profile Conversion Strategy

Profile Link Strategy

Profile Isolation Strategy

Best Match Strategy

Aliasing

Analytics

Introduction

Core Analytics (Beta)

Setup

Sync and Activate Analytics User Segments in mParticle

User Segment Activation

Welcome Page Announcements

Settings

Project Settings

Roles and Teammates

Organization Settings

Global Project Filters

Portfolio Analytics

Analytics Data Manager

Analytics Data Manager Overview

Events

Event Properties

User Properties

Revenue Mapping

Export Data

UTM Guide

Analyses

Analyses Introduction

Segmentation: Basics

Getting Started

Visualization Options

For Clauses

Date Range and Time Settings

Calculator

Numerical Settings

Segmentation: Advanced

Assisted Analysis

Properties Explorer

Frequency in Segmentation

Trends in Segmentation

Did [not] Perform Clauses

Cumulative vs. Non-Cumulative Analysis in Segmentation

Total Count of vs. Users Who Performed

Save Your Segmentation Analysis

Export Results in Segmentation

Explore Users from Segmentation

Funnels: Basics

Getting Started with Funnels

Group By Settings

Conversion Window

Tracking Properties

Date Range and Time Settings

Visualization Options

Interpreting a Funnel Analysis

Funnels: Advanced

Group By

Filters

Conversion over Time

Conversion Order

Trends

Funnel Direction

Multi-path Funnels

Analyze as Cohort from Funnel

Save a Funnel Analysis

Explore Users from a Funnel

Export Results from a Funnel

Cohorts

Getting Started with Cohorts

Analysis Modes

Save a Cohort Analysis

Export Results

Explore Users

Saved Analyses

Manage Analyses in Dashboards

Journeys

Getting Started

Event Menu

Visualization

Ending Event

Save a Journey Analysis

Users

Getting Started

User Activity Timelines

Time Settings

Export Results

Save A User Analysis

Query Builder

Data Dictionary

Query Builder Overview

Modify Filters With And/Or Clauses

Query-time Sampling

Query Notes

Filter Where Clauses

Event vs. User Properties

Group By Clauses

Annotations

Cross-tool Compatibility

Apply All for Filter Where Clauses

Date Range and Time Settings Overview

User Attributes at Event Time

Understanding the Screen View Event

User Aliasing

Dashboards

Dashboards––Getting Started

Manage Dashboards

Dashboard Filters

Organize Dashboards

Scheduled Reports

Favorites

Time and Interval Settings in Dashboards

Query Notes in Dashboards

Analytics Resources

The Demo Environment

Keyboard Shortcuts

User Segments

Tutorials

Analytics for Marketers

Analytics for Product Managers

Compare Conversion Across Acquisition Sources

Analyze Product Feature Usage

Identify Points of User Friction

Time-based Subscription Analysis

Dashboard Tips and Tricks

Understand Product Stickiness

Optimize User Flow with A/B Testing

APIs

User Segments Export API

Dashboard Filter API

Warehouse Sync

Data Privacy Controls

Data Subject Requests

Default Service Limits

Feeds

Cross-Account Audience Sharing

Approved Sub-Processors

Import Data with CSV Files

Import Data with CSV Files

CSV File Reference

Glossary

Video Index

Analytics (Deprecated)
Identity Providers

Single Sign-On (SSO)

Setup Examples

Settings

Debug Console

Data Warehouse Delay Alerting

Introduction

Developer Docs

Introduction

Integrations

Introduction

Rudderstack

Google Tag Manager

Segment

Data Warehouses and Data Lakes

Advanced Data Warehouse Settings

AWS Kinesis (Snowplow)

AWS Redshift (Define Your Own Schema)

AWS S3 Integration (Define Your Own Schema)

AWS S3 (Snowplow Schema)

BigQuery (Snowplow Schema)

BigQuery Firebase Schema

BigQuery (Define Your Own Schema)

GCP BigQuery Export

Snowflake (Snowplow Schema)

Snowplow Schema Overview

Snowflake (Define Your Own Schema)

APIs

Dashboard Filter API (Deprecated)

REST API

User Segments Export API (Deprecated)

SDKs

SDKs Introduction

React Native

iOS

Android

Java

JavaScript

Python

Object API

Developer Basics

Aliasing

Integrations
24i

Event

Aarki

Audience

Abakus

Event

Actable

Feed

ABTasty

Audience

Adikteev

Audience

Event

AdChemix

Event

AdMedia

Audience

Adjust

Event

Feed

Adobe Audience Manager

Audience

Adobe Marketing Cloud

Cookie Sync

Server-to-Server Events

Platform SDK Events

Adobe Target

Audience

Adobe Campaign Manager

Audience

AdPredictive

Feed

AgilOne

Event

Airship

Audience

Feed

Event

Algolia

Event

AlgoLift

Event

Feed

Amazon Advertising

Audience

Alooma

Event

Amazon Kinesis Firehose

Audience

Event

Amazon Kinesis

Event

Amazon Redshift

Data Warehouse

Amazon S3

Event

Amazon SNS

Event

Amobee

Audience

Amplitude

Event

Forwarding Data Subject Requests

Ampush

Audience

Event

Analytics

Audience

Event

Forwarding Data Subject Requests

Amazon SQS

Event

Anodot

Event

Antavo

Feed

Apptentive

Event

AppLovin

Audience

Event

Apptimize

Event

Attentive

Event

Feed

Apteligent

Event

Attractor

Event

Microsoft Azure Blob Storage

Event

Awin

Event

Batch

Event

Audience

Bidease

Audience

Bing Ads

Event

Bluecore

Event

Bluedot

Feed

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch

Event

Feed

Forwarding Data Subject Requests

Branch S2S Event

Event

Braze

Feed

Audience

Forwarding Data Subject Requests

Event

Bugsnag

Event

Button

Audience

Event

Cadent

Audience

Census

Feed

ciValue

Feed

Event

CleverTap

Audience

Event

Feed

Conversant

Event

comScore

Event

Cordial

Audience

Feed

Cortex

Event

Feed

Forwarding Data Subject Requests

Crossing Minds

Event

Criteo

Audience

Event

Custom Feed

Custom Feed

CustomerGlu

Event

Feed

Customer.io

Audience

Event

Feed

Datadog

Event

Databricks

Data Warehouse

Didomi

Event

Dynamic Yield

Audience

Event

Dynalyst

Audience

Edge226

Audience

Emarsys

Audience

Epsilon

Event

Everflow

Audience

Facebook

Event

Audience

Facebook Offline Conversions

Event

Fiksu

Audience

Event

Google Analytics for Firebase

Event

Flurry

Event

Flybits

Event

Formation

Event

Feed

ForeSee

Event

FreeWheel Data Suite

Audience

Foursquare

Audience

Feed

Friendbuy

Event

Google Ad Manager

Audience

Google Ads

Audience

Event

Google Analytics

Event

Google Analytics 4

Event

Google BigQuery

Audience

Data Warehouse

Google Cloud Storage

Audience

Event

Google Enhanced Conversions

Event

Google Marketing Platform

Cookie Sync

Audience

Event

Google Marketing Platform Offline Conversions

Event

Google Pub/Sub

Event

Google Tag Manager

Event

Heap

Event

Herow

Feed

Hightouch

Feed

Hyperlocology

Event

Impact

Event

Ibotta

Event

InMarket

Audience

ID5

Kit

InMobi

Audience

Event

Insider

Audience

Event

Feed

Intercom

Event

Inspectlet

Event

iPost

Audience

Feed

ironSource

Audience

Iterable

Audience

Event

Feed

Jampp

Event

Audience

Kayzen

Audience

Event

Kafka

Event

Kissmetrics

Event

Kochava

Event

Feed

Forwarding Data Subject Requests

Klaviyo

Audience

Event

Kubit

Event

LaunchDarkly

Feed

LifeStreet

Audience

Leanplum

Audience

Event

Feed

Liftoff

Audience

Event

LinkedIn

LinkedIn Conversions API Integration

LiveLike

Event

Liveramp

Audience

Localytics

Event

MadHive

Audience

mAdme Technologies

Event

Mailchimp

Event

Feed

Audience

Marigold

Audience

Mautic

Audience

Event

Mediasmart

Audience

MediaMath

Audience

Microsoft Azure Event Hubs

Event

Mintegral

Audience

Mixpanel

Audience

Forwarding Data Subject Requests

Event

MoEngage

Audience

Feed

Event

Monetate

Event

Moloco

Audience

Event

Movable Ink - V2

Event

Movable Ink

Event

Multiplied

Event

myTarget

Event

Audience

Nami ML

Feed

Nanigans

Event

NCR Aloha

Event

AppsFlyer

Feed

Event

Forwarding Data Subject Requests

Narrative

Audience

Event

Feed

Neura

Event

OneTrust

Event

Optimizely

Audience

Event

Oracle BlueKai

Event

Paytronix

Feed

Oracle Responsys

Audience

Event

Persona.ly

Audience

PieEye

Inbound Data Subject Requests

Personify XP

Event

Pilgrim

Event

Feed

Plarin

Event

Pinterest

Audience

Event

Punchh

Audience

Event

Feed

Postie

Audience

Event

Quadratic Labs

Event

Qualtrics

Event

Quantcast

Event

Radar

Event

Feed

Rakuten

Event

Reddit

Audience

Event

Regal

Event

Remerge

Audience

Event

Reveal Mobile

Event

Retina AI

Event

Feed

RevenueCat

Feed

Rokt

Audience

Event

RTB House

Audience

Event

Salesforce Email

Audience

Feed

Event

Salesforce Mobile Push

Event

Salesforce Sales and Service Cloud

Event

Sailthru

Audience

Event

Samba TV

Audience

Event

Scalarr

Event

SendGrid

Audience

Feed

SessionM

Event

Feed

ShareThis

Audience

Feed

Shopify

Feed

Custom Pixel

Signal

Event

SimpleReach

Event

Singular

Event

Feed

Singular-DEPRECATED

Event

Skyhook

Event

Slack

Event

Smadex

Audience

SmarterHQ

Event

Snapchat

Audience

Event

Snowflake

Data Warehouse

Snapchat Conversions

Event

Snowplow

Event

Split

Event

Feed

Splunk MINT

Event

Sprig

Audience

Event

StartApp

Audience

Statsig

Event

Feed

Talon.One

Audience

Event

Feed

Loyalty Feed

Stormly

Audience

Event

Tapad

Audience

Tapjoy

Audience

Swrve

Event

Feed

Taptica

Audience

Taplytics

Event

Teak

Audience

The Trade Desk

Cookie Sync

Audience

Event

Ticketure

Feed

TikTok Event

Audience

Audience (Deprecated)

Event

Audience Migration

Treasure Data

Audience

Event

TUNE

Event

Triton Digital

Audience

Valid

Event

Twitter

Event

Audience

Vkontakte

Audience

Voucherify

Audience

Event

Vungle

Audience

Webhook

Event

Webtrends

Event

White Label Loyalty

Event

Wootric

Event

Xandr

Audience

Cookie Sync

Yahoo (formerly Verizon Media)

Cookie Sync

Audience

Yotpo

Feed

YouAppi

Audience

Z2A Digital

Audience

Event

Zendesk

Feed

Event

Pushwoosh

Event

Audience

Primer

Event

Profile API

The Profile API can be used to query identities, user attributes, audience memberships, and other data available on an mParticle User Profile, anywhere you can make an HTTP request. Profile API can be used to drive one-to-one personalized experiences for your users across any channel:

  • Deliver customized product or content recommendations
  • Identify churn-risk customers in an automated voice support flow and launch a win-back campaign.
  • Deliver personalized offers in brick and mortar stores by integrating your point-of-sale systems.

Base URL

The base URL for the Profile API is https://api.mparticle.com.

Authentication

The Profile API is authenticated with a bearer token. To create a bearer token, first create a set of API credentials in the UI.

Create your API credentials

  1. Log in to your mParticle account.
  2. Hover your cursor over the Settings cog in the left nav bar, click Platform, and select the API Credentials tab.
  3. Click + Add Credential.
  4. Enter a descriptive name for the Display name.
  5. Check the box next to Profile API, and then expand the available workspaces by clicking the + button. Check the box next to each workspace you need to access user profile data for.
  6. Click Save, and copy the Client ID and Client Secret displayed in the modal window before clicking Done.

Create a bearer token

To create a bearer token, send a POST request to mParticle’s SSO token endpoint at https://sso.auth.mparticle.com/oauth/token.

The JSON body of the request must contain:

  • client_id - the client ID, issued by mParticle when creating the API credentials
  • client_secret - the client secret, issued by mParticle when creating the API credentials
  • audience - set to a value of "https://api.mparticle.com"
  • grant_type - set to a value of "client_credentials"

Example curl request

curl --request POST \
  --url https://sso.auth.mparticle.com/oauth/token \
  --header 'content-type: application/json' \
  --data '{"client_id":"your-client-id","client_secret":"your-client-secret","audience":"https://api.mparticle.com","grant_type":"client_credentials"}'

Example HTTP request

POST /oauth/token HTTP/1.1
Host: sso.auth.mparticle.com
Content-Type: application/json

{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "audience": "https://api.mparticle.com",
  "grant_type": "client_credentials"
}

Using your bearer token

A successful POST request to the token endpoint results in a JSON response as follows:

{
  "access_token": "YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-",
  "expires_in" : 28800,
  "token_type": "Bearer"
}

Subsequent requests to the API can then be authorized by setting the authorization header to:

Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-

Rate limits

mParticle imposes default service limits on the Profile API. For the specific limits on retrieving user profiles using the Profile API, see Default Service Limits.

Best practices

Do not submit client-side queries to Profile API from your application’s frontend. Instead, maximize performance in your app by creating a backend personalization service to submit these queries, acting as an intermediary between your app and the mParticle Profile API. This service can be built directly into your app’s existing backend framework, or it can an independent service.

As an example workflow:

  1. Your app’s client requests user information (like product recommendations) from your personalization service by providing an identifier for the current user.
  2. Your personalization service queries the Profile API using the supplied identifier. Based on information in the returned profile, your personalization service determines the best behavior for your app.
  3. Your personalization service send only the information necessary to implement the desired personalization to your app’s frontend. For example, an array of product recommendations.

A simple example personalization service implemented with Node and Express is available on GitHub.

Manage user profiles

Get a profile by mParticle ID

GET /userprofile/v1/{orgID}/{accountId}/{workspaceId}/{mpid}?fields=device_identities,user_identities,user_attributes,audience_memberships,attribution,partner_identities

Path parameters

Path Parameter Type Description
{orgID} Integer ID of the mParticle organization containing the user profile.
{accountID} Integer ID of the mParticle account containing the user profile.
{workspaceID} Integer ID of the mParticle workspace containing the user profile.
{mpid} Integer The mParticle ID for the user profile you want to retrieve.

Query parameters

Query Parameter Type Required Description
{fields} String Yes A comma-separated list of fields you want returned for the user profile. See list below for permitted values.

List of supported fields that can be returned with a user profile:

  • device_identities
  • user_identities
  • user_attributes (includes any calculated attributes)
  • audience_memberships
  • attribution
  • partner_identities

Example curl request

curl \
  -X GET \
  -H "Authorization: Bearer {accessToken}" \
  "https://api.mparticle.com/userprofile/v1/{orgId}/{accountId}/{workspaceId}/{mpid}?fields=device_identities,user_identities,user_attributes,audience_memberships,attribution,partner_identities"

Example JSON request body

No request body.

Response

A successful request receives a 200 response with a JSON object for the user profile.

{
  "mpid": 9080350317581165000,
  "created_timestamp_ms": 1574704283462,
  "last_stored_timestamp_ms": 1575301484215,
  "is_opted_out": false,
  "limit_ad_tracking": null,
  "device_identities": [
    {
      "type": "android_id",
      "encoding": "none",
      "value": "8789c459016a94b0"
    },
    {
      "type": "unknown",
      "encoding": "none",
      "value": "0c48aafbd6c69b3e1921fab5ccb528397eb1000854db2b99b1efc8507884b07a"
    },
    {
      "type": "google_advertising_id",
      "encoding": "none",
      "value": "481c8a31-7d5d-4d96-93a0-2de7427167fc"
    },
    {
      "type": "unknown",
      "encoding": "none",
      "value": "1b4469f3fb1f7bee7ba6705d1ce4b9d8a23e76592c34aa6c4a4eea3d0a07aa64"
    }
  ],
  "user_identities": [
    {
      "type": "customer_id",
      "encoding": "none",
      "value": "Example-Customer-mxr15"
    },
    {
      "type": "email",
      "encoding": "none",
      "value": "Example-Customer-mxr15@example.com"
    }
  ],
  "account_user_attributes": null,
  "user_attributes": {
    "ml_product_recs": [
      "123849",
      "294933",
      "937592",
      "500422"
    ],
    "view_preference": "Dark Mode",
    "tp_age": "18-34",
    "tp_gender": "male",
    "last_purchase_category": "Home Decor",
    "churn_risk_score": "4",
    "ltv": "342.1",
    "$city": "New York",
    "$state": "NY",
    "$country": "USA",
    "$firstname": "Marky",
    "$lastname": "Mark"
  },
  "audience_memberships": [
    {
      "audience_id": 17802,
      "audience_name": "Meret final CA test",
      "expiration_timestamp_ms": null
    },
    {
      "audience_id": 17918,
      "audience_name": "Decor Remarketing",
      "expiration_timestamp_ms": null
    }
  ],
   "partner_identities": {
        "partner_1": [
            {
                "name": "partner_1_customerId",
                "value": "a94f3e20-1cb7-49de-bf6a-537a204c4e15"
            }
        ],
        "partner_2": [
            {
                "name": "partner_2_userId",
                "value": "c2d18b7f-8a1e-4e6e-a9b0-7b7e1c9a5d34"
            }
        ]
    }
}

Get a profile by immutable ID

POST /userprofile/v1/resolve/{orgId}/{accountId}/{workspaceId}

Allows you to retrieve a profile without the mParticle ID. To use this method, your account must have an immutable identity configured in your identity strategy. An immutable identity is set only once and cannot be changed once it is set. It is usually the Customer ID.

Path parameters

Path Parameter Type Description
{orgID} Integer ID of the mParticle organization containing the user profile.
{accountID} Integer ID of the mParticle account containing the user profile.
{workspaceID} Integer ID of the mParticle workspace containing the user profile.

Query parameters

Query Parameter Type Required Description
{fields} String Yes A comma-separated list of fields you want returned for the user profile. See list below for permitted values.

List of supported fields that can be returned with a user profile:

  • device_identities
  • user_identities
  • user_attributes (including any calculated attributes)
  • audience memberships
  • attribution
  • partner_identities

Request body parameters

Name Type Required Description
environment_type string Yes Either development or production.
identity.type string Yes The type of identity being sent. Must be an immutable identity type, like customer_id or other
identity.value string Yes The identity value.

Example curl request

curl \
  -X POST \
  -H "Authorization: Bearer {accessToken}" \
  "https://api.mparticle.com/userprofile/v1/resolve/{orgId}/{accountId}/{workspaceId}?fields=device_identities,user_identities,user_attributes,audience_memberships,attribution,partner_identities" \
  -d "{ \"environment_type\": \"production\", \
    \"identity\": {\"type\": \"customer_id\",\"value\": \"12345\"}}"

Example JSON request body

{
  "environment_type": "production",
  "identity": {
    "type": "customer_id",
    "value": "12345"
  }
}

Response

A successful request receives a 200 response with a JSON object for the user profile.

{
  "mpid": 9080350317581165000,
  "created_timestamp_ms": 1574704283462,
  "last_stored_timestamp_ms": 1575301484215,
  "is_opted_out": false,
  "limit_ad_tracking": null,
  "device_identities": [
    {
      "type": "android_id",
      "encoding": "none",
      "value": "8789c459016a94b0"
    },
    {
      "type": "unknown",
      "encoding": "none",
      "value": "0c48aafbd6c69b3e1921fab5ccb528397eb1000854db2b99b1efc8507884b07a"
    },
    {
      "type": "google_advertising_id",
      "encoding": "none",
      "value": "481c8a31-7d5d-4d96-93a0-2de7427167fc"
    },
    {
      "type": "unknown",
      "encoding": "none",
      "value": "1b4469f3fb1f7bee7ba6705d1ce4b9d8a23e76592c34aa6c4a4eea3d0a07aa64"
    }
  ],
  "user_identities": [
    {
      "type": "customer_id",
      "encoding": "none",
      "value": "Example-Customer-mxr15"
    },
    {
      "type": "email",
      "encoding": "none",
      "value": "Example-Customer-mxr15@example.com"
    }
  ],
  "account_user_attributes": null,
  "user_attributes": {
    "ml_product_recs": [
      "123849",
      "294933",
      "937592",
      "500422"
    ],
    "view_preference": "Dark Mode",
    "tp_age": "18-34",
    "tp_gender": "male",
    "last_purchase_category": "Home Decor",
    "churn_risk_score": "4",
    "ltv": "342.1",
    "$city": "New York",
    "$state": "NY",
    "$country": "USA",
    "$firstname": "Marky",
    "$lastname": "Mark"
  },
  "audience_memberships": [
    {
      "audience_id": 17802,
      "audience_name": "Meret final CA test",
      "expiration_timestamp_ms": null
    },
    {
      "audience_id": 17918,
      "audience_name": "Decor Remarketing",
      "expiration_timestamp_ms": null
    }
  ],
  "partner_identities": {
        "partner_1": [
            {
                "name": "partner_1_customerId",
                "value": "a94f3e20-1cb7-49de-bf6a-537a204c4e15"
            }
        ],
        "partner_2": [
            {
                "name": "partner_2_userId",
                "value": "c2d18b7f-8a1e-4e6e-a9b0-7b7e1c9a5d34"
            }
        ]
    }
}

Error handling

Response code Error message Description
400 Bad request The request syntax is invalid or the requested profile is invalid.
401 Unauthorized Verify that you have created the correct API credentials for the FeatureName API and that you are using the correct authentication method.
403 Forbidden Verify that you have created the correct API credentials for the FeatureName API and that you are using the correct authentication method.
404 Not found The user profile either does not exist, or has expired.
429 Too Many Requests You have exceeded your provisioned limit. The endpoints may return a Retry-After response header with a value containing a non-negative decimal integer indicating the number of seconds to delay. If the header is not present, we recommend retrying your request in an exponential backoff pattern. Learn more about API throttling in Default Service Limits.
503 Service Unavailable The service is unavailable, we recommend retrying your request in an exponential backoff pattern.
5xx Server Error A server-side error occured, try your request again.

Profile expiration

User profiles expire and will not be returned by the Profile API if they are not accessed or updated for a period of 90 days. The default 90 day expiration period may be adjusted depending on your contract with mParticle. For more information about your account’s profile expiration period, contact your account representative.

Was this page helpful?

    Last Updated: July 3, 2025