Skip to content
Journeybee Help Center home
Journeybee Help Center home

API Keys

What are API Keys?

API Keys let you connect external applications and services to your Journeybee account. Think of them as secure passwords that allow other software to access your data without needing your login details.

What's on the API Keys Page

Your API Keys List

  • Label: Custom name for each API key to help you remember what it's for

  • Read Access: Whether the key can view your data (shown as True/False)

  • Write Access: Whether the key can modify your data (shown as True/False)

  • Actions: Delete button to remove keys you no longer need

Creating New Keys

  • Label: Give your key a descriptive name (e.g., "CRM Integration" or "Reporting Tool")

  • Read Access: Tick this box if the external service needs to view your data

  • Write Access: Tick this box if the external service needs to create or modify data

How to Use It

Creating an API Key

  1. Click "Create" at the top of the page

  2. Enter a descriptive label for your key

  3. Choose the access level:

    • Read Access: For viewing data only

    • Write Access: For creating or modifying data

  4. Click "Create API Key"

  5. Copy the generated key immediately - you won't see it again!

Managing Existing Keys

  • Edit the label of any key by clicking in the name field

  • Delete keys you no longer need using the bin icon

  • Remember to save your changes

Important Things to Know

  • Only Admin and Partnership users can access this page

  • Requires a premium subscription

  • Once created, you can't view the actual key value again - make sure to copy it straight away

  • Keys with write access can modify your data, so only give this to trusted applications

  • If you lose a key, delete the old one and create a new one

  • Each key shows its permissions clearly with green (True) or red (False) indicators

Security Tips

  • Only create keys when you actually need them

  • Use descriptive labels so you remember what each key is for

  • Regularly review and delete unused keys

  • Never share your API keys publicly or in unsecured locations

  • Consider using read-only access unless write access is absolutely necessary