Popl Documentation

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

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 generated via the Popl dashboard. For API Key access on the dashboard, you must have Full Team Admin permissions. The requested API Key must be made by a Popl Teams admin in order for our APIs to return team-wide lead data. Follow the steps below to generate and access your API key. Generate an API Key: 1. First, from the Home page of Popl Teams, click into the ‘Admin’ tab in the sidebar menu, and select ‘API Keys’

API Keys

1. On the API Keys page, click the button ‘Create API Key’ and enter a label for your API Key and click the ‘Next’ button. (Note: labels help organize and identify recently used API keys)

Label Your API Key

1. You will then be provided with your API Key. Click the button to ‘Copy & Close’ and the API Key will be saved to your clipboard. (Note: You will only see this API Key once. You can always return to the API Keys page to generate another API Key.)

Copy your API Key

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

Authorization: {your_api_key}

1. Once your API Key has been implemented, you’ll see a date appear in the ‘Date Last Used’ Column. You can delete any unneeded API keys by clicking on the three dots and clicking ‘Delete API Key’ (Note: Deleting an API key from the API Keys page will simply delete it from the list, it will not remove or affect your integration.)

Delete API Key

If any issues or questions, please contact us at [e-mail], we are available nearly 24/7 and will get back to you within 6-8 hours or less.

With 🤍 from Popl.