Developer API overview

Lexer offers a suite of APIs that allow your developers to push and pull your data from the Lexer CDXP, and supporting products and features. These APIs allow you to read and write profiles, transactions, and customer-event data. This information can then interoperate with other systems and platforms, and add new functionality to Lexer products.

API reference guide
For more information on all available APIs visit our API Reference Guide.

Things you need to know before getting started

  • All APIs are subject to Lexer’s License and Terms of Use.
  • All APIs are subject to Rate Limits.
  • All APIs require developers to Authenticate.
  • Some APIs are versioned.

Scopes and permissions

As a requirement, you will need access to the Lexer Hub if you would like to create and administer access to our APIs. If you have multiple Hubs, you will need to ensure you set each one up with an API, as configuration can vary for each CDXP. 

Please note:

  • Some APIs, like Profile Read API, require additional security configurations such as IP Whitelisting.
  • Some APIs may incur additional costs, or require Lexer to configure.
  • Some APIs may require approval from Lexer.

Please contact Lexer Support if you would like our Solutions team to help explore your options.

Status

For information on API status and breaking changes, visit Lexer Status.

API Concepts

Your data is organized in a specific way to ensure your MarTech stack is able to consume the data correctly. Your data is organized into datasets which contain events, and entities. These are enriched within your Hub into attributes, and unified into profiles.

Profiles, events, and entities

Within the Lexer CDXP, events are the primary external data types that populate your profiles with their history of transactions, emails, returns, etc. 

Events represent a one-time event in a ledger format that when aggregated, shows the present standing of a profile. We have the following event types:

  • Ecommerce purchase, and return.
  • In-store purchase, and return.
  • Email subscribe, send, open, click, and bounce.
  • SMS subscribe, send, and click.

Entities are commonly referenced in events, usually capturing metadata to aid in the enrichment of your profiles. For example, a product usually contains metadata that, when purchased, can inform you about the product preferences of the profile making the purchase. 

A product could contain:

  • Name
  • Categories
  • Images
  • Variations

This metadata can then be used to enrich profiles in your Hub through attributes like Colors Purchased, or Product Categories Purchased, when a profile makes a purchase. 

Profiles represent your customers. They contain all the enriched events provided, and are unified on identifiers such as email addresses, cell phone numbers, and any internal identifiers you provide.

For more information read about Unification.

Datasets

Within the Lexer CDXP, data is stored in datasets. Each one has a specific type that defines the automatic unification and enrichment of the data into the 360º customer view managed by Lexer. These types are: customer, ecommerce, point-of-sale, email, and SMS.

It’s common to have a dozen or more datasets in the Lexer CDXP, we recommend you create one for each unique platform or source of data, it will make administration much easier.
For example, you might have a separate dataset for:

  • Shopify
  • Klaviyo
  • Customer data stored in a data warehouse or ERP
  • Customer data captured from a recent NPS survey
  • Customer data purchased from a 3rd party list provider

Datasets are managed in the Dataset Manager within your Lexer hub. For more information, read about Dataset Management.

Attributes

Datasets, containing events and entities, are enriched within the lexer CDXP. The result for you is the attributes you see on your customer profiles. For example, we aggregate the lifetime spend of a profile, from all transactions across all commerce type datasets, and produce a Lifetime Value attribute.

Lexer has bottled best-in-class retail data science into the Lexer CDXP by producing over 300 290 highly-valuable, retail-focused attributes.

For more information, and a full list, read about Attributes on Learn. 

Custom attributes

You can go beyond our initial set of attributes by defining your own within the Lexer Hub. You’re able to do your own data science, or import new attributes from external systems not already provided by Lexer.

Custom attributes are defined on your datasets, and could be used to import:

  • Questions asked in competitions, forms, and surveys from external systems.
  • Outputs of your own data science work, such as churn or propensity scores.
  • Flags or statuses from externally managed or bought lists.
  • Specific customer details not captured in the existing customer dataset model.

For more information on how to add a custom attribute, read about Dataset Management.

Available schemas

With Lexer's File Upload API lets you upload Profile, Commerce, and Marketing schemas. This opens up a world of possibilities for handling and integrating data in a myriad of ways.

Profile schema

Allows the writing of your customer data into profiles within your Lexer CDXP. As well as providing profile linkage data for unification, capabilities include writing customer data like email addresses, phone numbers, names, birthdates, gender, etc. 

Commerce schema

Provides write endpoints for purchases, returns, products, and other commerce-related data to your Lexer CDXP to enrich profiles' purchase history.

Marketing schema

Contains write endpoints for email and SMS events on a profile including subscribes, sends, opens, clicks, and bounces. These are used to enrich profiles on your CDXP.

That’s a wrap

This overview has provided some details about how Lexer’s APIs work. If this seems like the right option for you, you are in the right place. Please continue to read through our API documentation using the above links, and reach out to your Success Manager if you have any questions.

Updated:
April 25, 2025
Did this page help you?
Thank you! Your feedback has been received!
Oops! Something went wrong while submitting the form, for assistance please contact support@lexer.io
Understanding APIs
Data
Developer APIs
Developer API overview
Data
Developer APIs
Javascript Tag basics
Data
Javascript Tag
Welcome to Lexer!
Fundamentals
Getting started
Identity Resolution
Fundamentals
Getting started
Our glossary
Fundamentals
Getting started
Integrations
Fundamentals
Setup
My account
Fundamentals
Setup
Manage team
Fundamentals
Setup
Group permissions
Fundamentals
Setup
Classifications
Fundamentals
Setup
Out of the box segments
Fundamentals
Setup
Lexi your AI companion
Fundamentals
Getting started
Browser guide
Fundamentals
Security
Corporate networks
Fundamentals
Security
Multi-factor authentication
Fundamentals
Security
Single sign-on
Fundamentals
Security
Lexer's ultimate troubleshooting guide
Fundamentals
Troubleshooting
Troubleshooting tech issues
Fundamentals
Troubleshooting
Troubleshooting integrations
Fundamentals
Troubleshooting
Troubleshooting Activate
Fundamentals
Troubleshooting
Troubleshooting Respond
Fundamentals
Troubleshooting
Help! My data is missing from the Hub
Fundamentals
Troubleshooting
How data is ingested into the CDP
Data
Self Serve Onboarding
Getting started onboarding data
Data
Self Serve Onboarding
Providing JSON data to Lexer
Data
Self Serve Onboarding
Providing CSV data to Lexer
Data
Self Serve Onboarding
Upload using SFTP
Data
Self Serve Onboarding
Secure file upload
Data
Self Serve Onboarding
Upload using S3
Data
Self Serve Onboarding
Lexer data specification
Data
Data Specification
Customer data specification
Data
Data Specification
Commerce data specification
Data
Data Specification
Marketing data specification
Data
Data Specification
Compliance data specification
Data
Data Specification
Data formatting and validation
Data
Data Specification
Rate limits
Data
Developer APIs
Product imagery
Data
Data Specification
Currency conversion
Data
Data Specification
Dataset management
Data
Data Management
Getting started with Logs
Data
Data Management
Chatbot API
Data
Developer APIs
Activity API
Data
Developer APIs
Read API
Data
Developer APIs
Javascript Tag use cases
Data
Javascript Tag
Export to CSV
Measure
Listen
Data in the CDXP
Data
Customer Data
CRM data
Data
Customer Data
Transaction data
Data
Customer Data
Email engagement data
Data
Customer Data
Experian data enrichment
Data
Customer Data
File upload API
Data
Developer APIs
Segment overview
Understand
Segment
Creating segments
Understand
Segment
Smart Search
Understand
Segment
Export attribute results
Understand
Segment
Fixing a disabled segment
Understand
Segment
Profile tab
Understand
Segment
Event Explorer
Understand
Segment
Lexer's attributes
Understand
Attributes
Predictive attributes
Understand
Attributes
Attribute value types
Understand
Attributes
Compare segments
Understand
Compare
Compare attributes
Understand
Compare
Activate overview
Engage
Activate
Ongoing activations
Engage
Activate
Audience splits
Engage
Activate
A/B splits
Engage
Activate
Control group splits
Engage
Activate
Inbox filtering
Engage
Respond
Ignored Senders
Engage
Respond
Forms for service
Engage
Respond
Workflow states
Engage
Respond
Bulk changes
Engage
Respond
Scheduled replies
Engage
Respond
Message templates
Engage
Respond
Customer profiles
Engage
Respond
Grouped messages
Engage
Respond
Automation rules
Engage
Respond
Redact messages
Engage
Respond
Contact Reporting
Engage
Contact
Serve Forms
Engage
Serve
Serve Reports
Engage
Serve
Serve Currency
Engage
Serve
Track overview
Measure
Track
Track Tables
Measure
Track
Activity overview
Measure
Activity
Team report
Measure
Activity
Cases report
Measure
Activity
Listen overview
Measure
Listen
Searching in Listen
Measure
Listen
Tier filters
Measure
Listen
Boolean search
Measure
Listen
Saved dives
Measure
Listen
Email notifications
Measure
Listen
Twitter data
Measure
Listen
Facebook data
Measure
Listen
Visualize overview
Measure
Visualize
Curate feed
Measure
Visualize
Report overview
Measure
Listen
Lexer Product Recommender → Klaviyo Integration
Grow
Lexer Product Recommender → Klaviyo Integration
Where do your best customers live? Use geographic insights to maximize media spend and conversion
Grow
Where do your best customers live? Use geographic insights to maximize media spend and conversion
Suppression audiences: How to use them and maximize your media effectiveness
Enrich
Suppression audiences: How to use them and maximize your media effectiveness
Measure campaign effectiveness: Track your KPIs and report on campaign performance
Enrich
Measure campaign effectiveness: Track your KPIs and report on campaign performance
Converting prospects: Acquire customers from your current, engaged prospect base (and save your ad spend!)
Acquire
Converting prospects: Acquire customers from your current, engaged prospect base (and save your ad spend!)
Understanding customer intent: Effective message personalization for buyers who shop outside their gender
Grow
Understanding customer intent: Effective message personalization for buyers who shop outside their gender
Deepen customer understanding: Use third-party data to identify insights for personalized messaging and increased engagement
Grow
Deepen customer understanding: Use third-party data to identify insights for personalized messaging and increased engagement
Basket analysis: Increasing customer lifetime value through targeted product bundling
Grow
Basket analysis: Increasing customer lifetime value through targeted product bundling
Persona building: Personalize your messaging for maximum return on your campaign investments
Grow
Persona building: Personalize your messaging for maximum return on your campaign investments
Driving customer loyalty: Identify, keep, and grow your most loyal customers
Retain
Driving customer loyalty: Identify, keep, and grow your most loyal customers
Increasing customer lifetime value: Upselling strategies
Grow
Increasing customer lifetime value: Upselling strategies
Reactivating lapsed customers: Retention and growth
Retain
Reactivating lapsed customers: Retention and growth
Welcome offer strategies: Using the Hub for analysis
Acquire
Welcome offer strategies: Using the Hub for analysis
Creating customer forms: Best practices
Enrich
Creating customer forms: Best practices
Connecting your MarTech stack with Lexer!
Enrich
Connecting your MarTech stack with Lexer!
Identifying win-back customers using the Second Last Order: Date attribute
Retain
Identifying win-back customers using the Second Last Order: Date attribute
Understanding customers' purchasing habits: Order Sequence filter
Grow
Understanding customers' purchasing habits: Order Sequence filter
Maximizing customer communications in Respond
Retain
Maximizing customer communications in Respond
Using Product Recommendation in the Hub to encourage repeat purchases
Grow
Using Product Recommendation in the Hub to encourage repeat purchases
Encouraging customer loyalty using birthday campaigns
Retain
Encouraging customer loyalty using birthday campaigns
Increasing customer lifetime value: Converting your one-time buyers into two-time buyers
Grow
Increasing customer lifetime value: Converting your one-time buyers into two-time buyers
Collecting zero-party data using Lexer Forms
Enrich
Collecting zero-party data using Lexer Forms
Measuring your data over time with Track
Enrich
Measuring your data over time with Track
UTM Creation Guidelines
UTM Creation Guidelines
UTM Creation Guidelines
Brand Assets
Brand Assets
Brand Assets
GTM guide to creating marketing materials with Lexer
GTM guide to creating marketing materials with Lexer
GTM guide to creating marketing materials with Lexer
How to use the Lexer Form Builder
How to use the Lexer Form Builder
How to use the Lexer Form Builder
Explore our standard integrations
Explore our standard integrations
Explore our standard integrations
Operating a CDP Practice LP
Operating a CDP Practice LP
Operating a CDP Practice LP
LP Sales Enablement
LP Sales Enablement
LP Sales Enablement
Video Training Courses LP
Video Training Courses LP
Video Training Courses LP
Purpose and Mission
Purpose and Mission
Purpose and Mission
Brand & Marketing LP
Brand & Marketing LP
Brand & Marketing LP
Stage 3 - QBRs and Customer insights
Stage 3 - QBRs and Customer insights
Stage 3 - QBRs and Customer insights
Client Onboarding Journey
Client Onboarding Journey
Client Onboarding Journey
Start your CDP Practice
Start your CDP Practice
Start your CDP Practice
Lexer Messaging
Lexer Messaging
Lexer Messaging
Pain point conversations
Pain point conversations
Pain point conversations
Lexer Ideal Customer Profile & Positioning
Lexer Ideal Customer Profile & Positioning
Lexer Ideal Customer Profile & Positioning
Referral Partner Program Overview
Referral Partner Program Overview
Referral Partner Program Overview
Demo Hub Guide
Demo Hub Guide
Demo Hub Guide