Support > How to get started with our Enterprise API

How to get started with our Enterprise API

Any questions? Get in touch.

Last updated: 31st January 2022


This support guide explains how to set up access to the Enterprise APIs. Our APIs allow our customers to access their data for in depth analysis in their existing tools.

Important Information about API Access

  • API Access is only available to team owners.
  • With your API Key, anyone can use the key to access your personal account and all of your data including private projects.


To set up an API Key:

  1. Click on the Manage your account settings option at the bottom of the Application Navigation Bar on the left side of the screen.
    The Settings window displays.
  2. Click API Access at the top of the screen.
  3. Click the Generate Access button.
    An API Key is generated and information on API requests and responses displays.
  4. Click any of the Authentication Headers or Pagination Headers fields to copy the text to your clipboard.
You've now set up access to the Pearler Enterprise API.

Re-generate API Key

  • You can re-generate an API Key at any point by clicking the Re-generate Access Secret button.
  • Re-generating will stop the existing key from working immediately.

Other Guides

Looking for more help using Pearler? No problem. Here are some other guides to help you get to know your way around all our great features.