Popl Documentation
  • Popl Documentation
  • Integrations
    • Syncing Members from Azure Active Directory (Entra ID)
      • Entra ID (Azure) - Auto Sync™
      • Entra ID (Azure) - Permissions
    • Syncing Members from Google Workspace
      • Google Workspace - Auto Sync™
      • Google Workspace - Permissions
    • Syncing Members from Workday
      • Workday - Auto Sync™
      • Workday - Permissions
    • Salesforce Integration
      • Salesforce - Lead/Contact Sync Logic
    • HubSpot Integration
    • HubSpot Integration (Legacy)
      • HubSpot - Contact Sync Logic (Legacy)
    • Dynamics 365 Sales Integration
    • Outlook Contact Sync - Full Team Integration
    • Outlook Contact Sync - Individual Member Integration
    • Zoho Integration
    • Monday Integration
    • Pipedrive Integration
    • Pardot Integration
    • Chili Piper Integration
    • Zapier Integration
    • VinSolutions Integration
    • Marketo Integration
    • Badge Kit Integration
  • SSO (SAML 2.0)
    • Azure SAML
    • Okta SAML
    • SCIM Provisioning
  • Email Signatures
    • Microsoft Outlook Email Signature Add-In
  • Members
    • Create New Member
    • Update Member
    • Get Members
    • Remove Member
  • Leads/Contacts
    • Get Last Lead
    • Get Leads by Time Period
    • Delete Lead
  • Analytics
    • Get Analytics
    • Get Views
Powered by GitBook
On this page
  • Overview
  • Authentication

Popl Documentation

Connect to the Popl API to push or pull lead, contact, member or analytics information directly from our database.

NextSyncing Members from Azure Active Directory (Entra ID)

Last updated 7 months ago

Overview

Popl Open API enables Popl customers to create, access, or manage leads, contacts, members or analytics externally with a simple and easy to use API. Connecting to our ecosystem can be great for:

  • Exporting leads to CRMs that Popl does not offer directly

  • Keeping multiple external databases up to date concurrently

  • Polling for new lead data that can then trigger other tasks

Authentication

The Popl API requires an api key to connect. This API key is unique per each account and can be requested at any time by asking your account executive or by sending us an email .

To make a call to the API, the api key must be passed in the Authorization header.

Authorization: {your_api_key}

To request an api key for yourself or your team, simply send us an email .

Teams (Popl Teams)

When connecting to the API to access lead data for a team, the requested api key must be made by a Popl Teams admin in order for our APIs to return team-wide lead data. If the requesting member is not an admin, the api key provided will only allow access to that individuals own leads.

Individuals (Pro or Pro+)

When connecting to the API to access lead data for an individual on Pro or Pro+, simply request an api key with your account email and all lead data for your single account will be accessible. For example, an api key for john@swift.com will not be able to access lead data that belongs to sarah@swift.com

Ready to get started? Click the next step below:

here
here