Welcome to the Contactlist, let's grow together!

ContactList
ContactListNumletive

Installation & Setup

This guide will help you set up ContactList, configure your workspace, and prepare your environment for development or production use.

Using the Dashboard

The easiest way to use ContactList is through our web dashboard. Simply visit dashboard.contactlist.io and sign up. No installation required!

Workspace Setup

Workspaces are like project folders that organize all your data. Each workspace is completely isolated:

  • Forms belong to a workspace
  • Email lists belong to a workspace
  • Data collections belong to a workspace
  • Campaigns belong to a workspace

You can create multiple workspaces for different projects, clients, or departments.

Creating a Workspace

  • Log in to your ContactList dashboard
  • Click on the workspace selector in the top navigation
  • Click "Create New Workspace"
  • Enter workspace name and description
  • Select your plan (Free, Pro, or Enterprise)
  • Click "Create Workspace"

Workspace Features

  • Multi-Workspace Support: Organize projects with separate workspaces
  • Workspace Isolation: Complete data separation between workspaces
  • Team Collaboration: Invite team members with different roles (owner, admin, member)
  • Workspace Switching: Easily switch between workspaces
  • Workspace-Level Settings: Configure defaults per workspace

Plans & Limits

Free Plan:

  • 0 active forms
  • 0 collections
  • 0 email lists
  • Limited features

Pro Plan:

  • 10 active forms
  • 5 collections
  • Unlimited email lists
  • 1 million data records
  • 10 active campaigns

Enterprise Plan:

  • Unlimited everything
  • Priority support
  • Custom integrations

Email Service Configuration

Before sending emails, you must configure an email service:

SMTP Setup

  • Go to Email Settings
  • Enter SMTP details:
    • Host (e.g., smtp.gmail.com)
    • Port (587 for TLS, 465 for SSL)
    • Username (your email)
    • Password (app password)
  • Test connection
  • Save

Resend Setup

  • Get API key from Resend
  • Enter in Email Settings
  • Test connection
  • Save

API Integration

To integrate ContactList into your application, you'll need to use our REST API. First, get your API key from the dashboard.

Getting Your API Key

  • Log in to your dashboard
  • Navigate to Settings → API Keys
  • Click "Create New API Key"
  • Copy and store your API key securely

Making Your First API Call

Here's an example using curl:

curl -X GET https://api.contactlist.io/v1/contacts \
  -H "Authorization: Bearer YOUR_API_KEY"

SDK Installation

We provide SDKs for popular programming languages to make integration easier.

JavaScript/TypeScript

npm install @contactlist/sdk

Python

pip install contactlist-sdk

Environment Variables

Store your API key securely using environment variables:

CONTACTLIST_API_KEY=your_api_key_here

External Database Integration

ContactList supports connecting to external databases for variable resolution in email campaigns.

  • Connect Databases: Connect to Supabase, Neon, PostgreSQL, or MySQL
  • Secure Connections: Encrypted connection strings
  • Variable Resolution: Use data from external databases in email campaigns
  • Query Caching: Performance optimization with caching
  • Rate Limiting: Prevent database overload
  • Performance Monitoring: Track query performance

Setting Up Database Connection

  • Navigate to Settings → External Databases
  • Click "Add Database"
  • Select database type (Supabase, Neon, PostgreSQL, MySQL)
  • Enter connection string (encrypted and stored securely)
  • Test connection
  • Save configuration

Next Steps

Once you have ContactList set up, check out: