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

# Quickstart

> Get up and running with Command in under 5 minutes. This guide walks you through login, navigation, and API integration.

## Get Started with Command

Welcome aboard! This guide will take you from zero to productive in just a few minutes. Whether you're an agent making your first call, a manager setting up your team, or a developer integrating via the API — we've got you covered.

<Info>
  **Before you begin**, make sure you have:

  * A modern web browser (Chrome, Edge, or Firefox recommended)
  * Your login credentials from your administrator
  * A stable internet connection (required for Voice Dialer)
</Info>

***

## The Onboarding Flow

Here's a quick look at what your first session will look like:

```mermaid theme={null}
flowchart LR
    A["Login"] --> B["Dashboard"]
    B --> C["Explore Features"]
    C --> D["Start Working"]

    style A fill:#2563eb,stroke:#1e40af,color:#ffffff
    style B fill:#3b82f6,stroke:#2563eb,color:#ffffff
    style C fill:#60a5fa,stroke:#3b82f6,color:#ffffff
    style D fill:#93c5fd,stroke:#60a5fa,color:#1e3a5f
```

***

## Step 1: Log In to Command

<Steps>
  <Step title="Open Command" icon="globe">
    Navigate to [command.cleargrid.ai](https://command.cleargrid.ai) in your browser (or [staging.cleargrid.ai](https://staging.cleargrid.ai) for the staging environment). You'll see the login screen.
  </Step>

  <Step title="Enter Your Credentials" icon="key">
    Type in the email address and password provided by your organization's administrator. If this is your first time, you'll be prompted to set a new password.
  </Step>

  <Step title="Complete Two-Factor Authentication" icon="shield-halved">
    If your organization has enabled 2FA, you'll receive a verification code on your registered device. Enter the code to continue.
  </Step>

  <Step title="Land on the Dashboard" icon="house">
    Once authenticated, you'll be taken directly to your personalized dashboard. Welcome to Command!
  </Step>
</Steps>

<Warning>
  If you've forgotten your password, click the **"Forgot Password"** link on the login screen. A reset link will be sent to your registered email address. Contact your administrator if you don't receive it.
</Warning>

***

## Step 2: Navigate the Dashboard

Your dashboard is your home base. Here's what you'll see:

<CardGroup cols={2}>
  <Card title="Key Metrics" icon="chart-pie">
    Total deals, monthly comparisons, and stage distribution are displayed front and center so you always know where things stand.
  </Card>

  <Card title="Recent Activity" icon="clock-rotate-left">
    A live feed of the latest borrower interactions, deal updates, and team activity — updated in real time.
  </Card>

  <Card title="Sidebar Navigation" icon="bars">
    Access all major sections: Dashboard, Borrowers & Deals, WhatsApp Inbox, Email Tickets, Reports, and Settings.
  </Card>

  <Card title="Quick Search" icon="magnifying-glass">
    Press `Ctrl + K` at any time to search for borrowers, deals, or tickets instantly from anywhere in the app.
  </Card>
</CardGroup>

<Tip>
  Pin the sections you use most to the top of your sidebar for faster access. Your layout preferences are saved automatically.
</Tip>

***

## Step 3: Your First 5 Minutes

Depending on your role, here's what we recommend doing first:

<Tabs>
  <Tab title="Agent">
    **Your mission:** Connect with borrowers and move deals forward.

    <Steps>
      <Step title="Check Your Assigned Deals" icon="list-check">
        Go to **Borrowers & Deals** and filter by **Assigned to Me**. This shows every deal on your plate.
      </Step>

      <Step title="Review Top-Priority Borrowers" icon="star">
        Sort by **Last Contact Date** to find borrowers who haven't been reached recently. These are your highest-priority follow-ups.
      </Step>

      <Step title="Make Your First Contact" icon="paper-plane">
        Open a borrower's profile and choose a channel — WhatsApp for a quick message, Voice for a direct call, or Email for a formal follow-up.
      </Step>

      <Step title="Update the Deal Stage" icon="arrows-rotate">
        After your interaction, move the deal to the appropriate stage on the Kanban board. Keeping stages current helps your whole team stay aligned.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Manager">
    **Your mission:** Monitor team performance and optimize workflows.

    <Steps>
      <Step title="Review Dashboard Metrics" icon="chart-line">
        Start on the Dashboard to see the big picture: total active deals, monthly performance trends, and stage distribution.
      </Step>

      <Step title="Check Team Activity" icon="users">
        View the Recent Activity feed to see what your agents have been working on. Look for gaps in outreach or stalled deals.
      </Step>

      <Step title="Review the Kanban Board" icon="kanban">
        Navigate to **Borrowers & Deals** and switch to the Kanban view. Look for bottlenecks — stages with too many deals may need attention.
      </Step>

      <Step title="Assign or Reassign Deals" icon="user-plus">
        Distribute workload evenly. Click a deal card and use the **Assign** dropdown to move it to the right agent.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Developer">
    **Your mission:** Integrate your systems with Command via the API.

    <Steps>
      <Step title="Get Your Credentials" icon="key">
        Contact ClearGrid to receive your lender identifier, email, and password for the API. You'll get credentials for both staging and production environments.
      </Step>

      <Step title="Authenticate" icon="lock">
        Call the [Lender Login](/api-reference/authentication/lender-login) endpoint to obtain your access token and refresh token.

        ```bash theme={null}
        curl -X POST https://stage-v3-api.cleargrid.ai/admin/auth/{lender}/login \
          -H "Content-Type: application/json" \
          -d '{"email":"your@email.com","password":"your_password"}'
        ```
      </Step>

      <Step title="Push Your First Account" icon="upload">
        Use the [Create & Update Account](/api-reference/accounts/create-update) endpoint to send account data to Command.

        ```bash theme={null}
        curl -X POST https://stage-v3-api.cleargrid.ai/admin/v3/lenders/{lenderPublicId}/accounts \
          -H "Authorization: Bearer <access_token>" \
          -H "Content-Type: application/json" \
          -d '{
            "accounts": [{
              "status": 1,
              "debtorCompanyId": "test_customer_001",
              "firstName": "Test",
              "lastName": "User",
              "language": "en",
              "accountId": "TEST-001",
              "subAccountId": "TEST-001-01",
              "principal": "1000",
              "interest": "0",
              "fees": "0",
              "paidAmount": "0",
              "loanType": 4
            }]
          }'
        ```
      </Step>

      <Step title="Verify in Command" icon="check">
        Log in to the [staging CRM](https://staging.cleargrid.ai/) and verify that your test account appears in the system.
      </Step>
    </Steps>
  </Tab>
</Tabs>

***

## API Integration Quick Reference

For developers integrating via the API, here's a quick reference of available endpoints:

| Endpoint                               | Method | Description                                        |
| -------------------------------------- | ------ | -------------------------------------------------- |
| `/admin/auth/{lender}/login`           | POST   | Authenticate and obtain access token               |
| `/admin/auth/{lender}/refresh-token`   | POST   | Refresh an expired access token                    |
| `/lenders/{id}/accounts`               | POST   | Create, update, or withdraw accounts               |
| `/lenders/{id}/accounts/update-status` | POST   | Update account statuses (disputed, do-not-contact) |

<CardGroup cols={2}>
  <Card title="Staging Environment" icon="flask">
    **API:** `stage-v3-api.cleargrid.ai`

    **CRM:** [staging.cleargrid.ai](https://staging.cleargrid.ai)

    Use for development and testing.
  </Card>

  <Card title="Production Environment" icon="server">
    **API:** `v3-api.cleargrid.ai`

    **CRM:** [command.cleargrid.ai](https://command.cleargrid.ai)

    Use for live operations.
  </Card>
</CardGroup>

***

## Account Lifecycle

Accounts in Command flow through a defined lifecycle managed via the API:

```mermaid theme={null}
flowchart LR
    A["Create (1)"] --> B["Update (2)"]
    B --> C["Update (2)"]
    C --> D["Settled"]
    A --> E["Withdraw (3)"]
    B --> E

    style A fill:#2563eb,stroke:#1e40af,color:#ffffff
    style B fill:#3b82f6,stroke:#2563eb,color:#ffffff
    style C fill:#60a5fa,stroke:#3b82f6,color:#ffffff
    style D fill:#10b981,stroke:#059669,color:#ffffff
    style E fill:#ef4444,stroke:#dc2626,color:#ffffff
```

| Status | Operation          | Description                                        |
| ------ | ------------------ | -------------------------------------------------- |
| `1`    | **Create**         | Onboard a new account or sub-account into Command  |
| `2`    | **Update**         | Reflect payments, fee changes, or data corrections |
| `3`    | **Withdraw**       | Remove or cancel an account/sub-account            |
| `5`    | **Disputed**       | Mark an account as disputed                        |
| `6`    | **Do Not Contact** | Block all communications for a customer            |

***

## Communication Channels

Command brings all your communication channels into one unified experience:

<Tabs>
  <Tab title="WhatsApp">
    **Best for:** Quick follow-ups, payment reminders, and informal conversations.

    1. Open the borrower's profile and click the **WhatsApp** icon
    2. Type your message in the chat window
    3. Use **message templates** for pre-approved content
    4. Press **Enter** to send — you'll see delivery and read receipts in real time
    5. All messages are automatically logged to the borrower's timeline

    <Note>
      WhatsApp messages require a pre-approved template for the first outbound message in a 24-hour window. After the borrower responds, you can send freeform messages.
    </Note>
  </Tab>

  <Tab title="Email">
    **Best for:** Formal communication, payment agreements, and detailed follow-ups.

    1. Open the borrower's profile and click the **Email** icon
    2. View existing email threads organized by date
    3. Click **Compose** to start a new email
    4. Fill in the subject line and body — use the rich text editor for formatting
    5. Attach files if needed and click **Send**
    6. Inbound replies will automatically create or update an Email Ticket
  </Tab>

  <Tab title="SMS">
    **Best for:** Quick alerts, payment reminders, and time-sensitive notifications.

    1. Open the borrower's profile and click the **SMS** icon
    2. Choose from a library of pre-built templates or write a custom message
    3. Use the **AI Generate** button to create a personalized message based on the borrower's context
    4. Review the message, then click **Send**
    5. Delivery status updates appear in real time
  </Tab>

  <Tab title="Voice">
    **Best for:** Personal conversations, negotiations, and high-priority outreach.

    1. Open the borrower's profile and click the **Phone** icon
    2. The call connects directly in your browser — no hardware or software required
    3. Use the on-screen controls to **mute**, **hold**, or **transfer** the call
    4. After the call, fill in the **interaction form** for compliance logging
    5. The call recording and notes are saved to the borrower's timeline automatically

    <Warning>
      Voice Dialer requires a microphone. Your browser will ask for permission the first time. Make sure to click **Allow** for calls to work properly.
    </Warning>
  </Tab>
</Tabs>

***

## Keyboard Shortcuts

Speed up your workflow with these handy shortcuts:

| Shortcut           | Action                  |
| ------------------ | ----------------------- |
| `Ctrl + K`         | Open quick search       |
| `Ctrl + N`         | Create new deal         |
| `Ctrl + Shift + M` | Open WhatsApp inbox     |
| `Esc`              | Close modals and panels |
| `Enter`            | Open selected deal      |
| `Ctrl + Enter`     | Send message in chat    |

***

## Next Steps

You're all set! Dive deeper into the features that matter most to your workflow:

<CardGroup cols={3}>
  <Card title="Dashboard Analytics" icon="chart-line" href="/features/dashboard/overview">
    Understand your metrics and track team performance with real-time analytics.
  </Card>

  <Card title="Borrower Management" icon="users" href="/features/borrower-management/overview">
    Learn how to manage borrower profiles, accounts, and interaction history.
  </Card>

  <Card title="Communication Hub" icon="messages" href="/features/communication/overview">
    Master multi-channel outreach across WhatsApp, Email, SMS, and Voice.
  </Card>

  <Card title="Voice Dialer" icon="phone" href="/features/voice-dialer/overview">
    Set up browser-based calling and learn the dialer controls.
  </Card>

  <Card title="Email Tickets" icon="ticket" href="/features/email-tickets/overview">
    Manage inbound email tickets with smart threading and team collaboration.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/overview">
    Integrate your systems using the Command API.
  </Card>
</CardGroup>

***

<Snippet file="snippets/support-info.mdx" />