API keys in Survey Tale allow secure programmatic access to your organization’s data and integrations. Each key can be scoped to specific projects, environments, and permission levels. Keep your keys private, anyone with your key can access data according to its permissions.

Step 1: Open Organization Settings

• Go to the bottom-left menu in the Survey Tale dashboard.

• Click Organization Settings.

Step 2: Go to the API Keys Tab

• In the left sidebar, select the API Keys tab.

• You’ll see a list of all existing keys (if any).

Step 3: Create a New API Key

• Click Add API Key.

• A setup window will appear.

Step 4: Configure the API Key

Provide details for your new key:

1. Label: Choose a clear name like “Zapier Integration” or “Slack Bot.”

2. Project Access:

   • Select the projects and environments this key can access.

   • Assign the appropriate permission level for each (Read, Write, or Manage).

   • You can grant access to multiple projects by clicking Add Permission.

3. Organization Access:

   • Choose read or write access for organization-level data.

Click Create to generate the key.

Step 5: Copy and Store the Key

• The full API key will appear only once.

• Copy it immediately and store it securely (e.g., password manager or vault).

• After leaving this page, the full key value can’t be viewed again.

Deleting an API Key

If you need to revoke a key:

1. Go to Organization Settings → API Keys.

2. Locate the key and click the trash icon.

3. Confirm deletion.
   The key will stop working immediately.

Permission Levels

Each API key can have different permission scopes per project:

You can also define organization-level permissions for broader administrative access.

Security Reminder

Treat your API key like a password. It grants access to your data based on the permissions you’ve configured. Once created, the full value can’t be retrieved again.