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

# LeadDocket

> How to set up the LeadDocket connector, plus the actions that are available.

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/lead-docket/filled/svg" alt="LeadDocket" className="connector-page-icon" />

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span className="connector-page-tag-beta connector-page-stage-tag">Beta</span><span>v1.0.0</span></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">26 actions</a> · 1 auth method</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">CRM</span>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

    <Columns cols={2}>
      <Card title="Connector Profile · API Key" href="/connectors/leaddocket/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/lead-docket/filled/svg" horizontal>
        Authenticate using your LeadDocket API key found in Manage > Settings > Account Settings.
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

    See the guide for the authentication type chosen in the Connector Profile:

    <Columns cols={2}>
      <Card title="Link Account · API Key" href="/connectors/leaddocket/guides/link-account/api-key" icon="https://stackone-logos.com/api/lead-docket/filled/svg" horizontal />
    </Columns>
  </Step>

  <Step title="Use Actions">
    Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

    Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).
  </Step>
</Steps>

## Actions

<div className="connector-meta-library-section">
  <div className="connector-actions-controls not-prose" data-connector-actions-controls>
    <div className="connector-actions-controls__row">
      <input type="search" className="connector-actions-search" data-connector-actions-search placeholder="Search actions" aria-label="Search actions" />
    </div>
  </div>

  <div className="meta-library-count" data-connector-actions-count>26 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid">
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Action</div>
        <div className="meta-library-grid-header-cell">Description</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_list_leads" data-action-label="List Leads" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Leads</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_list_leads" aria-label="Copy leaddocket_list_leads"><code className="connector-page-code">leaddocket\_list\_leads</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a paginated list of leads filtered by status ID with optional sub-status filtering and sort order</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_list_leads_updated_since" data-action-label="List Leads Updated Since" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Leads Updated Since</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_list_leads_updated_since" aria-label="Copy leaddocket_list_leads_updated_since"><code className="connector-page-code">leaddocket\_list\_leads\_updated\_since</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all leads updated since a given date, covering both status changes and edit events</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_get_lead" data-action-label="Get Lead" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Lead</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_get_lead" aria-label="Copy leaddocket_get_lead"><code className="connector-page-code">leaddocket\_get\_lead</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve full details of a single lead by ID including contact info, notes, messages, files, and custom fields</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_get_lead_basic" data-action-label="Get Lead Basic" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Lead Basic</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_get_lead_basic" aria-label="Copy leaddocket_get_lead_basic"><code className="connector-page-code">leaddocket\_get\_lead\_basic</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve basic information for a single lead without notes, messages, and other nested lists</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_update_lead" data-action-label="Update Lead" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Lead</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_update_lead" aria-label="Copy leaddocket_update_lead"><code className="connector-page-code">leaddocket\_update\_lead</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update properties of an existing lead such as case type, summary, incident date, office, and source</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_change_lead_status" data-action-label="Change Lead Status" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Change Lead Status</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_change_lead_status" aria-label="Copy leaddocket_change_lead_status"><code className="connector-page-code">leaddocket\_change\_lead\_status</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Change the status of a lead with optional sub-status, severity level, assigned users, and notes</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_add_lead_note" data-action-label="Add Lead Note" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Add Lead Note</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_add_lead_note" aria-label="Copy leaddocket_add_lead_note"><code className="connector-page-code">leaddocket\_add\_lead\_note</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Add a new note to a specified lead</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_create_contact" data-action-label="Create Contact" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Contact</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_create_contact" aria-label="Copy leaddocket_create_contact"><code className="connector-page-code">leaddocket\_create\_contact</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new contact with name, address, phone, email, and other details</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_get_contact" data-action-label="Get Contact" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Contact</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_get_contact" aria-label="Copy leaddocket_get_contact"><code className="connector-page-code">leaddocket\_get\_contact</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a single contact by ID with full details including custom fields and tags</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_update_contact" data-action-label="Update Contact" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Contact</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_update_contact" aria-label="Copy leaddocket_update_contact"><code className="connector-page-code">leaddocket\_update\_contact</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing contact's name, address, phone, email, and other properties</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_search_contacts" data-action-label="Search Contacts" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Search Contacts</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_search_contacts" aria-label="Copy leaddocket_search_contacts"><code className="connector-page-code">leaddocket\_search\_contacts</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Search for contacts by name, email, or phone number</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_list_contacts_updated_since" data-action-label="List Contacts Updated Since" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Contacts Updated Since</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_list_contacts_updated_since" aria-label="Copy leaddocket_list_contacts_updated_since"><code className="connector-page-code">leaddocket\_list\_contacts\_updated\_since</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all contacts updated since a given date with pagination</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_get_opportunity" data-action-label="Get Opportunity" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Opportunity</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_get_opportunity" aria-label="Copy leaddocket_get_opportunity"><code className="connector-page-code">leaddocket\_get\_opportunity</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve full details of an opportunity by ID including contact info, status, and custom fields</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_list_opportunities_unprocessed" data-action-label="List Unprocessed Opportunities" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Unprocessed Opportunities</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_list_opportunities_unprocessed" aria-label="Copy leaddocket_list_opportunities_unprocessed"><code className="connector-page-code">leaddocket\_list\_opportunities\_unprocessed</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all opportunities that have not been processed into leads</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_list_opportunities_created_since" data-action-label="List Opportunities Created Since" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Opportunities Created Since</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_list_opportunities_created_since" aria-label="Copy leaddocket_list_opportunities_created_since"><code className="connector-page-code">leaddocket\_list\_opportunities\_created\_since</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all opportunities created since a specific date with pagination</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_list_opportunities_updated_since" data-action-label="List Opportunities Updated Since" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Opportunities Updated Since</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_list_opportunities_updated_since" aria-label="Copy leaddocket_list_opportunities_updated_since"><code className="connector-page-code">leaddocket\_list\_opportunities\_updated\_since</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all opportunities updated since a specific date with pagination</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_list_users" data-action-label="List Users" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Users</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_list_users" aria-label="Copy leaddocket_list_users"><code className="connector-page-code">leaddocket\_list\_users</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of all LeadDocket users with their roles and permissions</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_get_user" data-action-label="Get User" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get User</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_get_user" aria-label="Copy leaddocket_get_user"><code className="connector-page-code">leaddocket\_get\_user</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a single user by ID with roles and permissions</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_list_users_by_role" data-action-label="List Users By Role" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Users By Role</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_list_users_by_role" aria-label="Copy leaddocket_list_users_by_role"><code className="connector-page-code">leaddocket\_list\_users\_by\_role</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve users assigned to a specific role by role ID</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_list_statuses" data-action-label="List Statuses" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Statuses</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_list_statuses" aria-label="Copy leaddocket_list_statuses"><code className="connector-page-code">leaddocket\_list\_statuses</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all lead statuses with their sub-statuses and configuration</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_get_status" data-action-label="Get Status" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Status</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_get_status" aria-label="Copy leaddocket_get_status"><code className="connector-page-code">leaddocket\_get\_status</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a single status by ID with its sub-statuses and configuration</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_list_tasks_by_lead" data-action-label="List Tasks By Lead" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Tasks By Lead</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_list_tasks_by_lead" aria-label="Copy leaddocket_list_tasks_by_lead"><code className="connector-page-code">leaddocket\_list\_tasks\_by\_lead</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all tasks for a specific lead</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_get_task" data-action-label="Get Task" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Task</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_get_task" aria-label="Copy leaddocket_get_task"><code className="connector-page-code">leaddocket\_get\_task</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a single task by ID</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_create_task" data-action-label="Create Task" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Task</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_create_task" aria-label="Copy leaddocket_create_task"><code className="connector-page-code">leaddocket\_create\_task</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new task on a lead with summary, start date, assigned user, and type</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_update_task" data-action-label="Update Task" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Task</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_update_task" aria-label="Copy leaddocket_update_task"><code className="connector-page-code">leaddocket\_update\_task</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing task's summary, start date, assigned user, type, or completion status</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="leaddocket_delete_task" data-action-label="Delete Task" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Task</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="leaddocket_delete_task" aria-label="Copy leaddocket_delete_task"><code className="connector-page-code">leaddocket\_delete\_task</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a task by ID</div>
      </div>
    </div>
  </div>
</div>