Userpilot Knowledge Base home pagelight logodark logo
    Platform
    Integrations
    Developer
    APIs
    APIs
    • Overview
    • Authentication
    • Environment
    Real-time HTTP
    • Overview
    • Identify User
    • Identify Company
    • Track Event
    • Endpoints
    Bulk Identify/Update
    • Users
    • Companies
    • Endpoints
    Bulk Import
    • Overview
    • Event Schema
    • Row Validation Rules
    • Best Practices
    • Endpoints
    Bulk Export
    • Overview
    • Event Schema
    • Data Lookups
    • Endpoints
    Bulk Delete
    • Overview
    APIs

    Userpilot API Documentation

    Welcome to Userpilot’s comprehensive API suite! This guide helps you understand the different ways to integrate with Userpilot, choose the right API for your needs, and get the most out of our platform’s capabilities.

    Real-time APIs

    Live user tracking & events

    Use cases:

    • Live user identification
    • Real-time event tracking
    • Instant personalization
    • Up-to-the-minute analytics

    Bulk Updates

    Update multiple profiles efficiently

    Use cases:

    • CRM data synchronization
    • Batch profile updates
    • Large-scale data sync
    • Company information updates

    Import Data

    Historical data migration

    Use cases:

    • Platform migration
    • Historical data backfill
    • Data warehouse replays
    • One-time data imports

    Export Data

    Analytics & reporting

    Use cases:

    • Custom analytics
    • Data warehouse integration
    • Compliance reporting
    • External analysis tools

    Delete Data

    Privacy compliance

    Use cases:

    • GDPR compliance
    • User data removal
    • Privacy regulations
    • Data cleanup requests

    Was this page helpful?

    Authentication
    twitterfacebooklinkedin
    Powered by Mintlify
    Assistant
    Responses are generated using AI and may contain mistakes.