> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getquinn.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with Quinn CRM in under 5 minutes

## Set Up Your Organization

<Steps>
  <Step title="Create Your Account">
    Sign up at your Quinn instance:

    ```bash theme={null}
    POST /api/auth/register
    ```

    ```json theme={null}
    {
      "email": "admin@yourcompany.com",
      "password": "your-secure-password",
      "organizationName": "Your Company Name",
      "firstName": "John",
      "lastName": "Doe"
    }
    ```

    <Note>
      The first user in an organization is automatically assigned the **admin** role.
    </Note>
  </Step>

  <Step title="Configure Organization Settings">
    Set up your business information:

    ```bash theme={null}
    PUT /api/settings/organization
    ```

    ```json theme={null}
    {
      "name": "ABC Equipment Rentals",
      "phone": "+1234567890",
      "email": "info@abcrentals.com",
      "website": "https://abcrentals.com",
      "address1": "123 Main St",
      "city": "Denver",
      "state": "CO",
      "zipCode": "80202",
      "businessHoursStart": "08:00",
      "businessHoursEnd": "17:00",
      "timezone": "America/Denver"
    }
    ```
  </Step>

  <Step title="Import Your First Customers">
    Upload a CSV file with customer data:

    <Tabs>
      <Tab title="Web UI">
        1. Navigate to **Customers** page
        2. Click **Import CSV**
        3. Select your file
        4. Map columns to Quinn fields
        5. Click **Import**
      </Tab>

      <Tab title="API">
        ```bash theme={null}
        POST /api/customers/import
        Content-Type: multipart/form-data
        ```

        ```bash theme={null}
        curl -X POST https://your-instance.replit.app/api/customers/import \
          -H "Cookie: sessionId=YOUR_SESSION_ID" \
          -F "file=@customers.csv"
        ```
      </Tab>
    </Tabs>

    <Accordion title="CSV Format Example">
      ```csv theme={null}
      Customer Name,Email,Phone,Address,City,State,Zip
      ABC Construction,contact@abc.com,555-0100,123 Oak St,Denver,CO,80202
      XYZ Contractors,info@xyz.com,555-0200,456 Elm St,Boulder,CO,80301
      ```
    </Accordion>
  </Step>

  <Step title="Set Up Your First Integration">
    Connect your phone system (Twilio or Aircall):

    <Tabs>
      <Tab title="Twilio">
        1. Go to **Settings** → **Integrations** → **Twilio**
        2. Enter your Twilio credentials:
           * Account SID
           * Auth Token
           * Phone Number
        3. Click **Test Connection**
        4. Click **Save**

        Quinn will automatically:

        * Configure webhooks for incoming calls/SMS
        * Set up call recording
        * Enable voice agent for after-hours calls
      </Tab>

      <Tab title="Aircall">
        1. Go to **Settings** → **Integrations** → **Aircall**
        2. Enter your Aircall API credentials
        3. Click **Test Connection**
        4. Click **Save**

        Features enabled:

        * Automatic call logging
        * Click-to-call from customer pages
        * Call transcription and AI analysis
      </Tab>
    </Tabs>
  </Step>

  <Step title="Invite Your Team">
    Add team members to your organization:

    ```bash theme={null}
    POST /api/organization/invite
    ```

    ```json theme={null}
    {
      "email": "teammate@yourcompany.com",
      "role": "user",
      "firstName": "Jane",
      "lastName": "Smith"
    }
    ```

    <Info>
      Available roles:

      * **user**: Standard access to CRM features
      * **admin**: Full access including organization settings
      * **super\_admin**: Platform-level access (Quinn team only)
    </Info>
  </Step>
</Steps>

## Next Steps

Now that you're set up, explore Quinn's features:

<CardGroup cols={2}>
  <Card title="Create Your Sales Pipeline" icon="chart-line" href="/guides/pipeline-setup">
    Set up custom stages and start tracking opportunities
  </Card>

  <Card title="Enable AI Voice Agent" icon="phone" href="/guides/voice-agent-setup">
    Configure Vapi for 24/7 automated receptionist
  </Card>

  <Card title="Sync Your Email" icon="envelope" href="/guides/email-sync">
    Connect Gmail or Outlook for automatic email tracking
  </Card>

  <Card title="Import Inventory" icon="boxes" href="/guides/inventory-import">
    Upload your equipment catalog and pricing
  </Card>
</CardGroup>

## Common Tasks

### Making an API Call

All API requests require authentication. After logging in, you'll receive a session cookie:

```javascript theme={null}
// Login
const response = await fetch('https://your-instance.replit.app/api/auth/login', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  credentials: 'include', // Important: includes cookies
  body: JSON.stringify({
    email: 'admin@yourcompany.com',
    password: 'your-password'
  })
});

// Use the session cookie for subsequent requests
const customers = await fetch('https://your-instance.replit.app/api/customers', {
  credentials: 'include' // Automatically includes sessionId cookie
});
```

### Creating a Lead

```javascript theme={null}
const lead = await fetch('https://your-instance.replit.app/api/leads', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  credentials: 'include',
  body: JSON.stringify({
    leadName: 'John Contractor',
    email: 'john@contractor.com',
    phone: '+15551234567',
    companyName: 'JC Construction',
    status: 'new'
  })
});
```

### Converting a Lead to Customer

```javascript theme={null}
const result = await fetch(`https://your-instance.replit.app/api/leads/${leadId}/convert`, {
  method: 'POST',
  credentials: 'include'
});

// Returns the newly created customer object
const customer = await result.json();
```

## Tips & Best Practices

<AccordionGroup>
  <Accordion title="Use Webhooks for Real-Time Updates">
    Quinn sends webhooks for important events:

    * New lead created
    * Opportunity stage changed
    * Missed call detected
    * AI task generated

    Configure webhook URLs in **Settings** → **Webhooks**
  </Accordion>

  <Accordion title="Enable AI Features Gradually">
    Start with basic features, then enable AI:

    1. **Week 1**: Import data, familiarize with UI
    2. **Week 2**: Enable call tracking and recording
    3. **Week 3**: Turn on AI task extraction
    4. **Week 4**: Enable voice agent and advanced AI

    This helps your team adjust to automation.
  </Accordion>

  <Accordion title="Leverage Bulk Import for Speed">
    Instead of manually entering data:

    * Use CSV import for customers/leads
    * Connect Snowflake for nightly syncs
    * Use Browse AI to discover job sites
    * Import XLSX files from other systems
  </Accordion>

  <Accordion title="Organize with Tags and Custom Fields">
    Add custom fields in **Settings** → **Custom Fields**:

    * Customer Type (residential, commercial, industrial)
    * Equipment Preferences (excavators, lifts, etc.)
    * Project Size (small, medium, large)
    * Payment Terms (net 30, COD, etc.)
  </Accordion>
</AccordionGroup>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Can't log in after registration">
    **Solution**: Check that you're accessing the correct instance URL. Session cookies are domain-specific.
  </Accordion>

  <Accordion title="CSV import failing">
    **Solution**: Ensure your CSV:

    * Has headers in the first row
    * Uses UTF-8 encoding
    * Has valid email addresses (if email column exists)
    * Phone numbers are in E.164 format (+1234567890)
  </Accordion>

  <Accordion title="Twilio calls not logging">
    **Solution**:

    1. Verify webhook URL is configured in Twilio console
    2. Check that Quinn instance is publicly accessible
    3. Review webhook logs in Quinn admin panel
  </Accordion>

  <Accordion title="Email sync not working">
    **Solution**:

    1. Re-authorize Gmail/Outlook connection
    2. Check that watch/subscription is active
    3. Verify webhook endpoint is reachable
    4. Contact support if issue persists
  </Accordion>
</AccordionGroup>

## Getting Help

Need assistance? We're here to help:

* 📧 **Email**: [support@quinn.app](mailto:support@quinn.app)
* 💬 **Discord**: [Join our community](https://discord.gg/quinn)
* 📚 **Docs**: Browse our [full documentation](/introduction)
* 🎯 **API Reference**: Explore [all endpoints](/api-reference/introduction)

***

Ready to dive deeper? Check out our [Feature Guides](/features/crm-overview) or explore the [API Reference](/api-reference/introduction).